NCBI C++ ToolKit
Public Member Functions | Private Attributes | List of all members
CCompactLayout Class Reference

Search Toolkit Book for CCompactLayout

CCompactLayout is amed to generate more compact 2D layout policy than layered layout for glyphs with non-uniform height. More...

#include <gui/widgets/seq_graphic/compact_layout_policy.hpp>

+ Inheritance diagram for CCompactLayout:
+ Collaboration diagram for CCompactLayout:

Public Member Functions

 CCompactLayout ()
 
TSeqPos GetMinDist (void) const
 access the minimum distance between two objects. More...
 
void SetMinDist (TSeqPos dist)
 
void SetVertSpace (int d)
 
ILayoutPolicy interface implementation.
virtual void BuildLayout (CLayoutGroup &group, SBoundingBox &bound) const
 Build layout for a list of layout objects. More...
 
- Public Member Functions inherited from CObject
 CObject (void)
 Constructor. More...
 
 CObject (const CObject &src)
 Copy constructor. More...
 
virtual ~CObject (void)
 Destructor. More...
 
CObjectoperator= (const CObject &src) THROWS_NONE
 Assignment operator. More...
 
bool CanBeDeleted (void) const THROWS_NONE
 Check if object can be deleted. More...
 
bool IsAllocatedInPool (void) const THROWS_NONE
 Check if object is allocated in memory pool (not system heap) More...
 
bool Referenced (void) const THROWS_NONE
 Check if object is referenced. More...
 
bool ReferencedOnlyOnce (void) const THROWS_NONE
 Check if object is referenced only once. More...
 
void AddReference (void) const
 Add reference to object. More...
 
void RemoveReference (void) const
 Remove reference to object. More...
 
void ReleaseReference (void) const
 Remove reference without deleting object. More...
 
virtual void DoNotDeleteThisObject (void)
 Mark this object as not allocated in heap – do not delete this object. More...
 
virtual void DoDeleteThisObject (void)
 Mark this object as allocated in heap – object can be deleted. More...
 
void * operator new (size_t size)
 Define new operator for memory allocation. More...
 
void * operator new[] (size_t size)
 Define new[] operator for 'array' memory allocation. More...
 
void operator delete (void *ptr)
 Define delete operator for memory deallocation. More...
 
void operator delete[] (void *ptr)
 Define delete[] operator for memory deallocation. More...
 
void * operator new (size_t size, void *place)
 Define new operator. More...
 
void operator delete (void *ptr, void *place)
 Define delete operator. More...
 
void * operator new (size_t size, CObjectMemoryPool *place)
 Define new operator using memory pool. More...
 
void operator delete (void *ptr, CObjectMemoryPool *place)
 Define delete operator. More...
 
virtual void DebugDump (CDebugDumpContext ddc, unsigned int depth) const
 Define method for dumping debug information. More...
 
- Public Member Functions inherited from CDebugDumpable
 CDebugDumpable (void)
 
virtual ~CDebugDumpable (void)
 
void DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const
 
void DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const
 
void DumpToConsole (void) const
 
- Public Member Functions inherited from ILayoutPolicy
virtual ~ILayoutPolicy ()
 
void SetSorter (TSorter &sorter)
 

Private Attributes

TSeqPos m_MinDist
 The minimum distance we permit two items to be within, horizontally. More...
 
int m_VertSpace
 

Additional Inherited Members

- Public Types inherited from CObject
enum  EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern }
 Control filling of newly allocated memory. More...
 
typedef CObjectCounterLocker TLockerType
 Default locker type for CRef. More...
 
typedef atomic< Uint8TCounter
 Counter type is CAtomiCounter. More...
 
typedef Uint8 TCount
 Alias for value type of counter. More...
 
- Public Types inherited from ILayoutPolicy
typedef list< CRef< CSeqGlyph > > TObjectList
 
typedef vector< CRef< CSeqGlyph > > TLayoutRow
 
typedef vector< TLayoutRowTLayout
 
typedef std::function< bool(const CRef< CSeqGlyph > &, const CRef< CSeqGlyph > &)> TSorter
 
- Static Public Member Functions inherited from CObject
static NCBI_XNCBI_EXPORT void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_XNCBI_EXPORT void ThrowNullPointerException (const type_info &type)
 
static EAllocFillMode GetAllocFillMode (void)
 
static void SetAllocFillMode (EAllocFillMode mode)
 
static void SetAllocFillMode (const string &value)
 Set mode from configuration parameter value. More...
 
- Static Public Member Functions inherited from CDebugDumpable
static void EnableDebugDump (bool on)
 
- Static Public Attributes inherited from CObject
static const TCount eCounterBitsCanBeDeleted = 1 << 0
 Define possible object states. More...
 
static const TCount eCounterBitsInPlainHeap = 1 << 1
 Heap signature was found. More...
 
static const TCount eCounterBitsPlaceMask
 Mask for 'in heap' state flags. More...
 
static const int eCounterStep = 1 << 2
 Skip over the "in heap" bits. More...
 
static const TCount eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2)
 Minimal value for valid objects (reference counter is zero) Must be a single bit value. More...
 
static const TCount eCounterStateMask
 Valid object, and object in heap. More...
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 
- Protected Member Functions inherited from ILayoutPolicy
void x_SeparateObjects (CLayoutGroup &group, TLayout &layout, SBoundingBox &bound, size_t group_size, int vert_space) const
 Separate objects into multiple sub-groups. More...
 
virtual void x_SetObjectPos (TLayout &layout, SBoundingBox &bound) const
 Set the objects' position (Y), and update the bounding box of the group (of all objects). More...
 
- Protected Attributes inherited from ILayoutPolicy
TSorter m_Sorter = nullptr
 

Detailed Description

CCompactLayout is amed to generate more compact 2D layout policy than layered layout for glyphs with non-uniform height.

But, it is also more expensive in terms of performance. This class can perform layout of a number of objects into a single panel of non-layered and non-overlapped layout. All the layout objects are spreaded out vertically with one connecting to the other without overlapping.

Definition at line 49 of file compact_layout_policy.hpp.

Constructor & Destructor Documentation

◆ CCompactLayout()

CCompactLayout::CCompactLayout ( )
inline

Definition at line 54 of file compact_layout_policy.hpp.

Member Function Documentation

◆ BuildLayout()

void CCompactLayout::BuildLayout ( CLayoutGroup group,
SBoundingBox bound 
) const
virtual

◆ GetMinDist()

TSeqPos CCompactLayout::GetMinDist ( void  ) const
inline

access the minimum distance between two objects.

CCompactLayout inline methods.

The distance is in bases.

Definition at line 80 of file compact_layout_policy.hpp.

References m_MinDist.

◆ SetMinDist()

void CCompactLayout::SetMinDist ( TSeqPos  dist)
inline

Definition at line 86 of file compact_layout_policy.hpp.

References m_MinDist.

Referenced by CFeatureTrack::x_UpdateData(), and CGeneModelTrack::x_UpdateData().

◆ SetVertSpace()

void CCompactLayout::SetVertSpace ( int  d)
inline

Member Data Documentation

◆ m_MinDist

TSeqPos CCompactLayout::m_MinDist
private

The minimum distance we permit two items to be within, horizontally.

Definition at line 72 of file compact_layout_policy.hpp.

Referenced by BuildLayout(), GetMinDist(), and SetMinDist().

◆ m_VertSpace

int CCompactLayout::m_VertSpace
private

Definition at line 73 of file compact_layout_policy.hpp.

Referenced by BuildLayout(), and SetVertSpace().


The documentation for this class was generated from the following files:
Modified on Sat Dec 09 04:45:03 2023 by modify_doxy.py rev. 669887