Search Toolkit Book for CLegendItemGlyph

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

Inheritance diagram for CLegendItemGlyph:

Collaboration diagram for CLegendItemGlyph:

Public Member Functions
	CLegendItemGlyph (const string &source_name, const string &label, const string &id, const CRgbaColor &legend_color, const CRgbaColor &text_color)

void	SetHost (ILegendHost *host)
	CLegendItemGlyph inline methods. More...

void	SetConfig (const CSeqGraphicConfig &config)

CSeqGlyph virtual methods.
virtual bool	OnLeftDblClick (const TModelPoint &)

virtual bool	OnContextMenu (wxContextMenuEvent &)

virtual void	GetHTMLActiveAreas (TAreaVector *p_ares) const
	Get html active areas. More...

virtual bool	IsClickable () const
	Query if this glyph is clickable. More...

Public Member Functions inherited from CSeqGlyph
	CSeqGlyph ()

virtual	~CSeqGlyph ()

virtual CRef< CSeqGlyph >	HitTest (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 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 void	Update (bool)
	Update content and layout including the bounding box. More...

virtual TSeqRange	GetRange (void) const
	get the total range of this object. More...

virtual bool	Accept (IGlyphVisitor *visitor)
	Interface for accepting an IGlyphVisitor. 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	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 CRenderingContext *	GetRenderingContext () 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 &)

bool	IsSelected () const

bool	IsHighlighted () const

CRgbaColor *	GetHighlightsColor () 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 TModelPoint &	GetPos () const

void	GetPosInWorld (TModelPoint &pos) const
	Get top left position in world coordinate. More...

const CSeqGlyph *	GetParent (void) const

CSeqGlyph *	GetParent (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)

CSeqGlyph *	SetParent (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...

CObject &	operator= (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)

CPtrToObjectProxy *	GetPtrProxy (void) const
	Get pointer to proxy object containing pointer to this object. More...

Protected Member Functions
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...

Protected Member Functions inherited from CSeqGlyph
virtual void	x_DrawHighlight () const

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
TSeqRange	m_Range

string	m_SourceName

string	m_Label

string	m_Id

CRgbaColor	m_LegendColor

CRgbaColor	m_TextColor

CConstRef< CSeqGraphicConfig >	m_gConfig

ILegendHost *	m_LHost

Additional Inherited Members
Public Types inherited from CSeqGlyph
enum	ENeighbours { eNghbrs_None = 0x0 , eNghbrs_Left = 0x1 , eNghbrs_Right = 0x2 , eNghbrs_Both = 0x3 }

typedef vector< CHTMLActiveArea >	TAreaVector

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< Uint8 >	TCounter
	Counter type is CAtomiCounter. More...

typedef Uint8	TCount
	Alias for value type of counter. 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)

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
CSeqGlyph *	m_Parent
	parent/child relationships for this feature More...

CRenderingContext *	m_Context
	the rendering context More...

unique_ptr< CRgbaColor >	m_HighlightsColor
	Highlight color. More...

ENeighbours	m_Neighbours
	Indicates whether the glyph has neighbours. More...

Detailed Description

Definition at line 55 of file legend_item_glyph.hpp.

Constructor & Destructor Documentation

◆ CLegendItemGlyph()

CLegendItemGlyph::CLegendItemGlyph	(	const string &	source_name,
		const string &	label,
		const string &	id,
		const CRgbaColor &	legend_color,
		const CRgbaColor &	text_color
	)

Definition at line 44 of file legend_item_glyph.cpp.

Member Function Documentation

◆ GetHTMLActiveAreas()

void CLegendItemGlyph::GetHTMLActiveAreas ( TAreaVector * ) const

virtual

Get html active areas.

This function is for CGI mode only. By default, it does nothing.

Reimplemented from CSeqGlyph.

Definition at line 70 of file legend_item_glyph.cpp.

References CHTMLActiveArea::fLegendItem, CHTMLActiveArea::fNoPin, CHTMLActiveArea::fNoSelection, CHTMLActiveArea::fNoTooltip, CSeqGlyph::GetHeight(), CSeqGlyph::GetLeft(), CSeqGlyph::GetRight(), CRenderingContext::GetVisSeqFrom(), CRenderingContext::GetVisSeqTo(), CGlRect< T >::Init(), CHTMLActiveArea::m_Bounds, CHTMLActiveArea::m_Color, CSeqGlyph::m_Context, CHTMLActiveArea::m_Flags, CHTMLActiveArea::m_ID, m_Id, m_Label, m_LegendColor, CHTMLActiveArea::m_SeqRange, CHTMLActiveArea::m_Signature, COpenRange< Position >::Set(), CRgbaColor::ToString(), and CSeqGlyph::x_Local2World().

◆ IsClickable()

bool CLegendItemGlyph::IsClickable ( ) const

inlinevirtual

Query if this glyph is clickable.

Mainly for chaging mouse cursor for clickable glyph. By default, it returns false. If a glyph is clickable, but there is no need to change mouse cursor due to any other reason, such as there is already other visual hint, then don't need to override this function.

Reimplemented from CSeqGlyph.

Definition at line 102 of file legend_item_glyph.hpp.

◆ OnContextMenu()

bool CLegendItemGlyph::OnContextMenu ( wxContextMenuEvent & )

virtual

Reimplemented from CSeqGlyph.

Definition at line 62 of file legend_item_glyph.cpp.

References ILegendHost::LH_OnItemRightClick(), m_LHost, and m_SourceName.

◆ OnLeftDblClick()

bool CLegendItemGlyph::OnLeftDblClick ( const TModelPoint & )

virtual

Reimplemented from CSeqGlyph.

Definition at line 54 of file legend_item_glyph.cpp.

References ILegendHost::LH_OnItemDblClick(), m_LHost, and m_SourceName.

◆ SetConfig()

void CLegendItemGlyph::SetConfig ( const CSeqGraphicConfig & config )

inline

Definition at line 95 of file legend_item_glyph.hpp.

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

◆ SetHost()

void CLegendItemGlyph::SetHost ( ILegendHost * host )

inline

CLegendItemGlyph inline methods.

Definition at line 89 of file legend_item_glyph.hpp.

References m_LHost.

◆ x_Draw()

void CLegendItemGlyph::x_Draw ( ) const

protectedvirtual

The default renderer for this layout object.

Implements CSeqGlyph.

Definition at line 96 of file legend_item_glyph.cpp.

References _ASSERT, IRender::ColorC(), CRenderingContext::DrawQuad(), CGlTextureFont::eFontFace_Helvetica, CSeqGlyph::GetBottom(), GetGl(), CSeqGraphicConfig::GetLabelFont(), CSeqGlyph::GetLeft(), CSeqGlyph::GetTop(), kLegendBarWidth, kLegendLabelGap, CSeqGlyph::m_Context, m_gConfig, m_Label, m_LegendColor, m_TextColor, Ref(), CRenderingContext::ScreenToSeq(), and CRenderingContext::TextOut().

◆ x_UpdateBoundingBox()

void CLegendItemGlyph::x_UpdateBoundingBox ( )

inlineprotectedvirtual

Update the bounding box assuming children's sizes are fixed if any.

Implements CSeqGlyph.

Definition at line 108 of file legend_item_glyph.hpp.

Member Data Documentation

◆ m_gConfig

CConstRef<CSeqGraphicConfig> CLegendItemGlyph::m_gConfig

private

Definition at line 81 of file legend_item_glyph.hpp.

Referenced by SetConfig(), and x_Draw().

◆ m_Id

string CLegendItemGlyph::m_Id

private

Definition at line 78 of file legend_item_glyph.hpp.

Referenced by GetHTMLActiveAreas().

◆ m_Label

string CLegendItemGlyph::m_Label

private

Definition at line 77 of file legend_item_glyph.hpp.

Referenced by GetHTMLActiveAreas(), and x_Draw().

◆ m_LegendColor

CRgbaColor CLegendItemGlyph::m_LegendColor

private

Definition at line 79 of file legend_item_glyph.hpp.

Referenced by GetHTMLActiveAreas(), and x_Draw().

◆ m_LHost

ILegendHost* CLegendItemGlyph::m_LHost

private

Definition at line 82 of file legend_item_glyph.hpp.

Referenced by OnContextMenu(), OnLeftDblClick(), and SetHost().

◆ m_Range

TSeqRange CLegendItemGlyph::m_Range

private

Definition at line 75 of file legend_item_glyph.hpp.

◆ m_SourceName

string CLegendItemGlyph::m_SourceName

private

Definition at line 76 of file legend_item_glyph.hpp.

Referenced by OnContextMenu(), and OnLeftDblClick().

◆ m_TextColor

CRgbaColor CLegendItemGlyph::m_TextColor

private

Definition at line 80 of file legend_item_glyph.hpp.

Referenced by x_Draw().

The documentation for this class was generated from the following files:

include/gui/widgets/seq_graphic/legend_item_glyph.hpp
src/gui/widgets/seq_graphic/legend_item_glyph.cpp

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CLegendItemGlyph()

Member Function Documentation

◆ GetHTMLActiveAreas()

◆ IsClickable()

◆ OnContextMenu()

◆ OnLeftDblClick()

◆ SetConfig()

◆ SetHost()

◆ x_Draw()

◆ x_UpdateBoundingBox()

Member Data Documentation

◆ m_gConfig

◆ m_Id

◆ m_Label

◆ m_LegendColor

◆ m_LHost

◆ m_Range

◆ m_SourceName

◆ m_TextColor