NCBI C++ ToolKit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
CLayoutGroup Class Reference

Search Toolkit Book for CLayoutGroup

CLayoutGroup is a container of CSeqGlyphs (layout objects). More...

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

+ Inheritance diagram for CLayoutGroup:
+ Collaboration diagram for CLayoutGroup:

Public Types

typedef ILayoutPolicy::TObjectList TObjectList
 
- Public Types inherited from CSeqGlyph
enum  ENeighbours { eNghbrs_None = 0x0 , eNghbrs_Left = 0x1 , eNghbrs_Right = 0x2 , eNghbrs_Both = 0x3 }
 
typedef vector< CHTMLActiveAreaTAreaVector
 
typedef list< CRef< CSeqGlyph > > TObjects
 
typedef list< CConstRef< CSeqGlyph > > TConstObjects
 
- 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 Member Functions

 CLayoutGroup (ELinkedFeatDisplay LinkedFeat=ELinkedFeatDisplay::eLFD_Default)
 
virtual ~CLayoutGroup (void)
 
void SetConfig (const CBoundaryParams *conf)
 Set composition boundary parameters. More...
 
void SetLayoutPolicy (ILayoutPolicy *policy)
 Set policy on how to deploy the layout of its children. More...
 
void UpdateBoundingBox ()
 update group's bounding box only. More...
 
void UpdateLayout ()
 update group's bounding box only, and its parent layout. More...
 
bool AllChildrenSameType () const
 Return true if there are 0 or 1 children, or all children are features of the same type (e.g. More...
 
void SetAsMaster (CRef< CSeqGlyph > master)
 master glyph has some special meaning (e.g. More...
 
bool IsMaster (const CSeqGlyph *glyph) const
 
void HideMaster (bool hidden=true)
 
bool IsMasterHidden () const
 
void SetLinkedFeat (ELinkedFeatDisplay LinkedFeat)
 
ELinkedFeatDisplay GetLinkedFeat () const
 
ICompostion interface implementation.

Return the object list.

const TObjectListGetChildren () const
 CLayoutGroup inline methods. More...
 
TObjectListGetChildren ()
 
size_t GetChildrenNum () const
 Get total number of children. More...
 
CConstRef< CSeqGlyphGetChild (int idx) const
 Get the layout object at index 'idx'. More...
 
CRef< CSeqGlyphGetChild (int idx)
 Get the layout object at index 'idx'. More...
 
int GetIndex (const CSeqGlyph *obj) const
 Get the child index. More...
 
bool Remove (CSeqGlyph *obj)
 Remove a layout object. More...
 
bool Replace (CSeqGlyph *obj, int idx)
 Replace a child at index 'idx'. More...
 
void Insert (int at, CSeqGlyph *obj)
 Insert a layout object before the given index. More...
 
void Insert (const CSeqGlyph *at_obj, CSeqGlyph *obj)
 Insert a layout object before the given layout object. More...
 
void InsertAft (const CSeqGlyph *at_obj, CSeqGlyph *obj)
 Insert a layout object after the given layout object. More...
 
void PushBack (CSeqGlyph *obj)
 Append a layout object to the end. More...
 
void PushFront (CSeqGlyph *obj)
 
void Set (const TObjectList &objs)
 
void Append (TObjectList &objs)
 
TObjectListSetChildren ()
 
void Clear ()
 
CSeqGlyph interface implementation
virtual void Update (bool layout_only)
 Update content and layout including the bounding box. More...
 
virtual CRef< CSeqGlyphHitTest (const TModelPoint &p)
 Hit testing. More...
 
virtual bool HitTestHor (TSeqPos x, const CObject *obj)
 
virtual bool Intersects (const TModelRect &rect, TConstObjects &objs) const
 Intersect testing. More...
 
virtual void GetHTMLActiveAreas (TAreaVector *p_areas) const
 Get html active areas. More...
 
virtual bool Accept (IGlyphVisitor *visitor)
 Interface for accepting an IGlyphVisitor. More...
 
- Public Member Functions inherited from CSeqGlyph
 CSeqGlyph ()
 
virtual ~CSeqGlyph ()
 
virtual bool NeedTooltip (const TModelPoint &, ITooltipFormatter &, string &) const
 Check if need to show tooltip. More...
 
virtual void GetTooltip (const TModelPoint &, ITooltipFormatter &tt, string &t_title) const
 Get the tooltip if available. More...
 
virtual TSeqRange GetRange (void) const
 get the total range of this object. More...
 
virtual bool SetSelected (bool flag)
 Select or deselect this glyph. More...
 
virtual void SetHideLabel (bool)
 Force to hide label. More...
 
virtual bool HasSideLabel () const
 Query if there is label and label is on the side. More...
 
virtual bool IsClickable () const
 Query if this glyph is clickable. More...
 
virtual bool LessBySeqPos (const CSeqGlyph &obj) const
 compare this object to another based on glyph sequence position. More...
 
bool LessByPos (const CSeqGlyph &obj) const
 compare this object to another, based on glyph geometry position. More...
 
bool LessBySeqSize (const CSeqGlyph &obj) const
 compare this object to another, based on sequence size. More...
 
bool LessBySize (const CSeqGlyph &obj) const
 compare this object to another, based on geometry size. More...
 
void Draw () const
 render the layout. More...
 
TModelRect GetModelRect () const
 get the bounding box. More...
 
bool IsIn (const TModelPoint &p) const
 Hit test for points in PARENT COORD. More...
 
bool IsIn (TModelUnit x, TModelUnit y) const
 
bool IsInHor (TModelUnit x) const
 
void SetRender (IGlyphRenderer *renderer)
 set customized renderer for this layout objects. More...
 
void SetRenderingContext (CRenderingContext *context)
 Set the rendering context. More...
 
const CRenderingContextGetRenderingContext () const
 Get the rendering context. More...
 
void SetTearline (size_t Tearline)
 tearline factor – used to limit a list of glyphs More...
 
size_t GetTearline () const
 
void SetTearlineText (const string &sTearlineText)
 tearline text – if set, is appended to the glyph name (does not naffect processing otherwise) More...
 
string GetTearlineText () const
 
void SetRowNum (size_t cur_row)
 
size_t GetRowNum () const
 
void SetVisible (size_t v)
 
size_t GetVisible () const
 
int GetLevel () const
 
void SetLevel (int Level)
 
virtual string GetPName () const
 persistent name of the glyph should not depend on the instance of the glyph, but should uniquely reflect its contents so two glyphs having the same contents will have the same name currently used to track isDrawn() status for expandable glyphs default implementation returns an empty string implementations exist for CFeatGlyph (name of the contained feature) and CLayoutGroup (concatenation of all sorted children names) More...
 
float GetFadeFactor () const
 
virtual bool OnLeftDown (const TModelPoint &)
 
virtual bool OnLeftUp (const TModelPoint &)
 
virtual bool OnLeftDblClick (const TModelPoint &)
 
virtual bool OnContextMenu (wxContextMenuEvent &event)
 
bool IsSelected () const
 
bool IsHighlighted () const
 
CRgbaColorGetHighlightsColor () const
 
virtual TModelUnit GetHeight () const
 
virtual TModelUnit GetWidth () const
 
virtual TModelUnit GetLeft () const
 
virtual TModelUnit GetTop () const
 
virtual TModelUnit GetRight () const
 
virtual TModelUnit GetBottom () const
 
const TModelPointGetPos () const
 
void GetPosInWorld (TModelPoint &pos) const
 Get top left position in world coordinate. More...
 
const CSeqGlyphGetParent (void) const
 
CSeqGlyphGetParent (void)
 
ENeighbours GetNeighbours () const
 
void SetHighlighted (bool flag)
 
void SetHighlightsColor (const CRgbaColor &hl_color)
 
void SetHighlightsColor (const string &hl_color_str)
 
virtual void SetWidth (TModelUnit w)
 
virtual void SetHeight (TModelUnit h)
 
virtual void SetLeft (TModelUnit l)
 
virtual void SetTop (TModelUnit b)
 
virtual void SetPos (const TModelPoint &upper_left)
 
void SetParent (CSeqGlyph *p)
 
CSeqGlyphSetParent (void)
 
void SetNeighbours (ENeighbours neighbours)
 
- Public Member Functions inherited from CObjectEx
 CObjectEx (void)
 
virtual ~CObjectEx (void)
 
- 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 CWeakObject
 CWeakObject (void)
 
virtual ~CWeakObject (void)
 
CPtrToObjectProxyGetPtrProxy (void) const
 Get pointer to proxy object containing pointer to this object. More...
 

Static Public Member Functions

static void PropagateRelatedSelection (bool isSelected, CSeqGlyph *pGlyph, CSeqGlyph *pGlyphFrom=NULL)
 set "RelatedGlyphSelected" in CLayoutGroup-based glyph hierarchies everywhere in the hierarchy containing the given glyph More...
 
- Static Public Member Functions inherited from CSeqGlyph
static bool PointInRect (const TModelPoint &p, const TModelRect &rc)
 
static bool PointInRect (TModelUnit x, TModelUnit y, const TModelRect &rc)
 
- 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)
 

Protected Member Functions

void x_DrawBoundary () const
 
bool x_isDrawn () const
 determines whether the glyph should be drawn or not at all (currently children of unselected parents when m_LinkedFeat is set to "Expandable") More...
 
bool x_HasExpandedChildren () const
 
CSeqGlyph virtual methods.
virtual void x_Draw () const
 The default renderer for this layout object. More...
 
virtual void x_UpdateBoundingBox ()
 Update the bounding box assuming children's sizes are fixed if any. More...
 
virtual void x_DrawHighlight () const
 override x_DrawHighlight() to do nothing. More...
 
- Protected Member Functions inherited from CSeqGlyph
void x_DrawInnerLabelColumns (TModelUnit base, const string &label, const CRgbaColor &color, const CGlTextureFont &font, bool side_label_visible) const
 
void x_DrawInnerLabels (TModelUnit base, const string &label, const CRgbaColor &color, const CGlTextureFont &font, bool side_label_visible, bool inside_only, vector< TModelRange > *labels_ranges=nullptr, TSeqRange *interval=nullptr, bool XOR_mode=false) const
 
void x_DrawTruncatedLabel (const string &label, const CGlTextureFont &font, TModelUnit width, TModelUnit x, TModelUnit y, vector< TModelRange > *labels_ranges=nullptr) const
 
void x_DrawException () const
 Draw a shading background to indicate exception. More...
 
virtual void x_OnLayoutChanged ()
 update the layout. More...
 
void x_Parent2Local (TModelPoint &pnt) const
 Transform the coordiante from parent coord. to local coord. More...
 
void x_Parent2Local (TModelUnit &, TModelUnit &y) const
 Transform the coordiante from parent coord. to local coord. More...
 
void x_Parent2Local (TModelRect &rect) const
 Transform the coordiante from parent coord. to local coord. More...
 
void x_World2Local (TModelPoint &p) const
 Transform the coordiante from world coord. to local coord. More...
 
void x_World2Local (TModelUnit &x, TModelUnit &y) const
 
void x_Local2World (TModelPoint &p) const
 Transform the coordiantes from local coord. to world coord. More...
 
void x_Local2World (TModelUnit &x, TModelUnit &y) const
 
void x_InitHTMLActiveArea (CHTMLActiveArea &area) const
 initialize the basic information for a given active area. More...
 
bool x_Visible_V () const
 is this glyph visible in vertical direction? More...
 
template<class T >
bool x_IntersectVisible (const CRange< T > &SeqRange, T &from, T &to) const
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 
- Protected Member Functions inherited from CWeakObject
void CleanWeakRefs (void) const
 Method cleaning all CWeakRefs referencing at this moment to the object After calling to this method all existing CWeakRefs referencing to the object will return NULL, so it effectively will be equal to deleting the object. More...
 

Private Attributes

CIRef< ILayoutPolicym_Policy
 
TObjectList m_Children
 
CConstRef< CBoundaryParamsm_Config
 boundary settings More...
 
CRef< CSeqGlyphm_MasterGlyph
 
bool m_HideMaster
 
ELinkedFeatDisplay m_LinkedFeat
 linkage mode for the track where this glyph is residing More...
 

Additional Inherited Members

- 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 Attributes inherited from CSeqGlyph
CSeqGlyphm_Parent
 parent/child relationships for this feature More...
 
CRenderingContextm_Context
 the rendering context More...
 
unique_ptr< CRgbaColorm_HighlightsColor
 Highlight color. More...
 
ENeighbours m_Neighbours
 Indicates whether the glyph has neighbours. More...
 

Detailed Description

CLayoutGroup is a container of CSeqGlyphs (layout objects).

Itself is one type of many layout objects. It simply takes a set of layout objects, and generates layout based on the given layout policy.

Definition at line 53 of file layout_group.hpp.

Member Typedef Documentation

◆ TObjectList

Definition at line 56 of file layout_group.hpp.

Constructor & Destructor Documentation

◆ CLayoutGroup()

CLayoutGroup::CLayoutGroup ( ELinkedFeatDisplay  LinkedFeat = ELinkedFeatDisplay::eLFD_Default)

Definition at line 49 of file layout_group.cpp.

References m_LinkedFeat.

Referenced by x_UpdateBoundingBox().

◆ ~CLayoutGroup()

virtual CLayoutGroup::~CLayoutGroup ( void  )
inlinevirtual

Definition at line 59 of file layout_group.hpp.

Member Function Documentation

◆ Accept()

bool CLayoutGroup::Accept ( IGlyphVisitor visitor)
virtual

Interface for accepting an IGlyphVisitor.

The visitor will be passed to its child glyphs for composite glyph.

Returns
true if continue the traversal and false, otherwise.

Reimplemented from CSeqGlyph.

Reimplemented in CGeneGroup.

Definition at line 257 of file layout_group.cpp.

References m_Children, and IGlyphVisitor::Visit().

Referenced by CGlyphContainer::Accept().

◆ AllChildrenSameType()

bool CLayoutGroup::AllChildrenSameType ( ) const

Return true if there are 0 or 1 children, or all children are features of the same type (e.g.

all introns)

Definition at line 395 of file layout_group.cpp.

References CFeatGlyph::GetFeature(), ITERATE, m_Children, NULL, and t.

Referenced by CFeatGlyph::x_RedundantLabelCheck(), and CVcfGlyph::x_RedundantLabelCheck().

◆ Append()

void CLayoutGroup::Append ( TObjectList objs)
inline

◆ Clear()

void CLayoutGroup::Clear ( void  )
inline

◆ GetChild() [1/2]

CRef< CSeqGlyph > CLayoutGroup::GetChild ( int  idx)

Get the layout object at index 'idx'.

Definition at line 93 of file layout_group.cpp.

References i, m_Children, and CRef< C, Locker >::Reset().

◆ GetChild() [2/2]

CConstRef< CSeqGlyph > CLayoutGroup::GetChild ( int  idx) const

◆ GetChildren() [1/2]

CLayoutGroup::TObjectList & CLayoutGroup::GetChildren ( void  )
inline

Definition at line 258 of file layout_group.hpp.

References m_Children.

◆ GetChildren() [2/2]

const CLayoutGroup::TObjectList & CLayoutGroup::GetChildren ( void  ) const
inline

◆ GetChildrenNum()

size_t CLayoutGroup::GetChildrenNum ( ) const
inline

◆ GetHTMLActiveAreas()

void CLayoutGroup::GetHTMLActiveAreas ( TAreaVector ) const
virtual

◆ GetIndex()

int CLayoutGroup::GetIndex ( const CSeqGlyph obj) const

Get the child index.

Returns
-1 if there is no such object.

Definition at line 55 of file layout_group.cpp.

References i, and m_Children.

Referenced by CLayoutTrackHandler::x_MoveTrackDownRecursive(), and CLayoutTrackHandler::x_MoveTrackUpRecursive().

◆ GetLinkedFeat()

ELinkedFeatDisplay CLayoutGroup::GetLinkedFeat ( ) const
inline

Definition at line 165 of file layout_group.hpp.

References m_LinkedFeat.

Referenced by ILayoutPolicy::x_SeparateObjects(), and x_UpdateBoundingBox().

◆ HideMaster()

void CLayoutGroup::HideMaster ( bool  hidden = true)
inline

Definition at line 149 of file layout_group.hpp.

References m_HideMaster.

Referenced by CGeneGroup::SetShowGene().

◆ HitTest()

CRef< CSeqGlyph > CLayoutGroup::HitTest ( const TModelPoint p)
virtual

Hit testing.

Test whether a given point in PARENT's COORD. SYSTEM falls inside this layout object. Recursive hit testing may happen if this layout object is a container of other layout objects.

Returns
the object that gets hit.

Reimplemented from CSeqGlyph.

Definition at line 197 of file layout_group.cpp.

References CSeqGlyph::HitTest(), CSeqGlyph::IsIn(), m_Children, NON_CONST_ITERATE, and CSeqGlyph::x_Parent2Local().

Referenced by CLinkedFeatsGroup::HitTest(), CGlyphContainer::HitTest(), and CGraphOverlay::HitTest().

◆ HitTestHor()

bool CLayoutGroup::HitTestHor ( TSeqPos  x,
const CObject obj 
)
virtual

Reimplemented from CSeqGlyph.

Definition at line 213 of file layout_group.cpp.

References CSeqGlyph::IsInHor(), m_Children, and NON_CONST_ITERATE.

Referenced by CGlyphContainer::HitTestHor().

◆ Insert() [1/2]

void CLayoutGroup::Insert ( const CSeqGlyph at_obj,
CSeqGlyph obj 
)

Insert a layout object before the given layout object.

If no matched at_obj found, the object will be added to the end.

Definition at line 161 of file layout_group.cpp.

References m_Children, CSeqGlyph::m_Context, CSeqGlyph::SetParent(), and CSeqGlyph::SetRenderingContext().

◆ Insert() [2/2]

void CLayoutGroup::Insert ( int  at,
CSeqGlyph obj 
)

Insert a layout object before the given index.

If index is out of bound, the object is added to the end.

Definition at line 145 of file layout_group.cpp.

References i, m_Children, CSeqGlyph::m_Context, CSeqGlyph::SetParent(), and CSeqGlyph::SetRenderingContext().

Referenced by CAlignmentTrack::x_AddAlignFeatLayout().

◆ InsertAft()

void CLayoutGroup::InsertAft ( const CSeqGlyph at_obj,
CSeqGlyph obj 
)

Insert a layout object after the given layout object.

If no matched at_obj found, the object will be added to the end.

Definition at line 174 of file layout_group.cpp.

References m_Children, CSeqGlyph::m_Context, NON_CONST_ITERATE, PushBack(), CSeqGlyph::SetParent(), and CSeqGlyph::SetRenderingContext().

Referenced by CGeneModelTrack::x_AddCDSProduct_FeatsLayout(), and CGeneModelTrack::x_AddFeatProductLayout().

◆ Intersects()

bool CLayoutGroup::Intersects ( const TModelRect rect,
TConstObjects objs 
) const
virtual

Intersect testing.

Test weather a given rectangular area intersects with this layout object. Recursive intersect testing is necessary if the layout object is a container of other containers. All the intersected leaf objects will be added into objs. The rect is in parent's coord system.

Reimplemented from CSeqGlyph.

Definition at line 224 of file layout_group.cpp.

References CSeqGlyph::GetModelRect(), CGlRect< T >::Intersects(), ITERATE, m_Children, and CSeqGlyph::x_Parent2Local().

Referenced by CGlyphContainer::Intersects().

◆ IsMaster()

bool CLayoutGroup::IsMaster ( const CSeqGlyph glyph) const
inline

◆ IsMasterHidden()

bool CLayoutGroup::IsMasterHidden ( ) const
inline

Definition at line 150 of file layout_group.hpp.

References m_HideMaster.

◆ PropagateRelatedSelection()

void CLayoutGroup::PropagateRelatedSelection ( bool  isSelected,
CSeqGlyph pGlyph,
CSeqGlyph pGlyphFrom = NULL 
)
static

set "RelatedGlyphSelected" in CLayoutGroup-based glyph hierarchies everywhere in the hierarchy containing the given glyph

Definition at line 456 of file layout_group.cpp.

References GetChildren(), CSeqGlyph::GetLevel(), CSeqGlyph::GetParent(), NON_CONST_ITERATE, and CFeatGlyph::SetRelatedGlyphSelected().

Referenced by CFeatGlyph::SetSelected().

◆ PushBack()

void CLayoutGroup::PushBack ( CSeqGlyph obj)
inline

◆ PushFront()

void CLayoutGroup::PushFront ( CSeqGlyph obj)
inline

◆ Remove()

bool CLayoutGroup::Remove ( CSeqGlyph obj)

◆ Replace()

bool CLayoutGroup::Replace ( CSeqGlyph obj,
int  idx 
)

Replace a child at index 'idx'.

Definition at line 125 of file layout_group.cpp.

References i, m_Children, CSeqGlyph::m_Context, CSeqGlyph::SetParent(), and CSeqGlyph::SetRenderingContext().

◆ Set()

void CLayoutGroup::Set ( const TObjectList objs)
inline

◆ SetAsMaster()

void CLayoutGroup::SetAsMaster ( CRef< CSeqGlyph master)
inline

master glyph has some special meaning (e.g.

represents feature that is a parent of all other features represented by glyphs of the layout) there is no requirement for a layout to have a master object but if there is one then it is supposed to be among children (calling SetAsMaster() does _not_ insert it to the child list)

Definition at line 147 of file layout_group.hpp.

References m_MasterGlyph.

Referenced by CGeneGroup::SetShowGene(), and CSGFeatureJob::x_CreateFeature_Recursive().

◆ SetChildren()

CLayoutGroup::TObjectList & CLayoutGroup::SetChildren ( void  )
inline

◆ SetConfig()

void CLayoutGroup::SetConfig ( const CBoundaryParams conf)
inline

Set composition boundary parameters.

The settings is not required. It will only be used when there is a need to show the bounding box for this composition.

Definition at line 270 of file layout_group.hpp.

References m_Config, and CConstRef< C, Locker >::Reset().

Referenced by CDummyTrack::CDummyTrack(), CAlignmentTrack::x_AddAlignFeatLayout(), CSixFramesTransTrack::x_AddTranslations(), CFeatureTrack::x_InitGlyphs_Recursive(), and ILayoutPolicy::x_SeparateObjects().

◆ SetLayoutPolicy()

void CLayoutGroup::SetLayoutPolicy ( ILayoutPolicy policy)
inline

◆ SetLinkedFeat()

void CLayoutGroup::SetLinkedFeat ( ELinkedFeatDisplay  LinkedFeat)
inline

Definition at line 164 of file layout_group.hpp.

References m_LinkedFeat.

Referenced by CFeatureTrack::x_AdjustFeatureLayout().

◆ Update()

void CLayoutGroup::Update ( bool  )
virtual

Update content and layout including the bounding box.

Parameters
layout_onlyif true only update the layout not the content. May need to update the layout only under certain situation, e.g. selection. The update is recursive if this is a container layout. By default, it updates the bounding box only.

Reimplemented from CSeqGlyph.

Reimplemented in CGeneGroup.

Definition at line 188 of file layout_group.cpp.

References m_Children, NON_CONST_ITERATE, and x_UpdateBoundingBox().

Referenced by CLinkedFeatsGroup::SetSelected(), CGeneGroup::Update(), CLinkedFeatsGroup::Update(), CGlyphContainer::Update(), CGeneModelTrack::x_AddCDSProduct_FeatsLayout(), and CGeneModelTrack::x_AddFeatProductLayout().

◆ UpdateBoundingBox()

void CLayoutGroup::UpdateBoundingBox ( )
inline

update group's bounding box only.

Definition at line 330 of file layout_group.hpp.

References x_UpdateBoundingBox().

Referenced by CTrackContainer::RemoveEmptyTracks().

◆ UpdateLayout()

void CLayoutGroup::UpdateLayout ( )
inline

◆ x_Draw()

void CLayoutGroup::x_Draw ( ) const
protectedvirtual

◆ x_DrawBoundary()

void CLayoutGroup::x_DrawBoundary ( ) const
protected

◆ x_DrawHighlight()

virtual void CLayoutGroup::x_DrawHighlight ( ) const
inlineprotectedvirtual

override x_DrawHighlight() to do nothing.

Reimplemented from CSeqGlyph.

Definition at line 174 of file layout_group.hpp.

◆ x_HasExpandedChildren()

bool CLayoutGroup::x_HasExpandedChildren ( ) const
protected

Definition at line 268 of file layout_group.cpp.

References GetChildren(), CFeatGlyph::isDrawn(), ITERATE, and x_isDrawn().

Referenced by x_isDrawn(), and x_UpdateBoundingBox().

◆ x_isDrawn()

bool CLayoutGroup::x_isDrawn ( ) const
protected

determines whether the glyph should be drawn or not at all (currently children of unselected parents when m_LinkedFeat is set to "Expandable")

Definition at line 292 of file layout_group.cpp.

References eLFD_Expandable, m_LinkedFeat, and x_HasExpandedChildren().

Referenced by CGeneGroup::GetHTMLActiveAreas(), GetHTMLActiveAreas(), CGeneGroup::x_Draw(), x_Draw(), x_HasExpandedChildren(), and x_UpdateBoundingBox().

◆ x_UpdateBoundingBox()

void CLayoutGroup::x_UpdateBoundingBox ( )
protectedvirtual

Member Data Documentation

◆ m_Children

TObjectList CLayoutGroup::m_Children
private

◆ m_Config

CConstRef<CBoundaryParams> CLayoutGroup::m_Config
private

boundary settings

Definition at line 186 of file layout_group.hpp.

Referenced by SetConfig(), x_DrawBoundary(), and x_UpdateBoundingBox().

◆ m_HideMaster

bool CLayoutGroup::m_HideMaster
private

◆ m_LinkedFeat

ELinkedFeatDisplay CLayoutGroup::m_LinkedFeat
private

linkage mode for the track where this glyph is residing

Definition at line 191 of file layout_group.hpp.

Referenced by CLayoutGroup(), GetLinkedFeat(), SetLinkedFeat(), x_isDrawn(), and x_UpdateBoundingBox().

◆ m_MasterGlyph

CRef<CSeqGlyph> CLayoutGroup::m_MasterGlyph
private

Definition at line 187 of file layout_group.hpp.

Referenced by IsMaster(), and SetAsMaster().

◆ m_Policy

CIRef<ILayoutPolicy> CLayoutGroup::m_Policy
private

Definition at line 184 of file layout_group.hpp.

Referenced by SetLayoutPolicy(), and x_UpdateBoundingBox().


The documentation for this class was generated from the following files:
Modified on Wed Feb 21 09:54:08 2024 by modify_doxy.py rev. 669887