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

Search Toolkit Book for CGraphTrack

CGraphTrack –. More...

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

+ Inheritance diagram for CGraphTrack:
+ Collaboration diagram for CGraphTrack:

Public Types

enum  ELayout { eLayout_Layered , eLayout_Overlay , eLayout_Overlayed }
 
- Public Types inherited from CGlyphContainer
typedef vector< CRef< CCommentGlyph > > TComments
 
typedef set< stringTHighlights
 
typedef map< string, THighlightsTKeyHighlights
 
- Public Types inherited from CLayoutTrack
enum  FTrackAttr {
  fMovable = 1 << 0 , fCollapsible = 1 << 1 , fFrameVisible = 1 << 2 , fShowTitle = 1 << 3 ,
  fShowAlways = 1 << 4 , fFullTrack = 1 << 5 , fNavigable = 1 << 6 , fShowIcons = 1 << 7 ,
  fDefaultAttr
}
 
typedef vector< CConstRef< CSeqGlyph > > TLayObjVector
 
typedef unsigned TTrackAttrFlags
 
typedef list< CRef< CLayoutTrack > > TLayoutTracks
 
typedef map< string, stringTKeyValuePairs
 
- 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 Types inherited from CEventHandler
enum  EDispatch { eDispatch_SelfOnly , eDispatch_AllHandlers , eDispatch_FirstHandler , eDispatch_Default = eDispatch_AllHandlers }
 enum controlling dispatching strategies More...
 
enum  EPoolName {
  ePool_Default = 0 , ePool_Parent , ePool_Child , ePool_Sibling ,
  ePool_NextAvailable
}
 Identifiers for standard pools. More...
 
typedef vector< CEventHandler * > TListeners
 
typedef map< int, TListenersTPools
 
typedef list< AutoPtr< SPostRequest > > TPostRequests
 
typedef std::map< CEventHandler *, intTHandlerToCount
 
typedef void(* FOnPostCallback) ()
 

Public Member Functions

 CGraphTrack (CSGGraphDS *ds, CRenderingContext *r_cntx)
 
virtual ~CGraphTrack ()
 
virtual CRef< CSGGenBankDSGetDataSource ()
 Method for accessing the data source. More...
 
virtual CConstRef< CSGGenBankDSGetDataSource () const
 
virtual void GetHTMLActiveAreas (TAreaVector *p_areas) const
 Get html active areas. More...
 
virtual CHTMLActiveAreaInitHTMLActiveArea (TAreaVector *p_areas) const
 Initialize the HTML active area for a track. More...
 
void SetAnnot (const string &annot)
 
const stringGetAnnot () const
 
void SetLayout (ELayout layout)
 
CLayoutTrack public methods.
virtual const CTrackTypeInfoGetTypeInfo () const
 
ILegendProvide methods.
virtual void GetLegend (const CTempTrackProxy *track_proxy, objects::CTrackConfig::TLegend &legend) const
 
IDroppable virtual methods overloading.
virtual bool CanDrop (CRef< CLayoutTrack > &track)
 
virtual bool Drop (CRef< CLayoutTrack > &track)
 
- Public Member Functions inherited from CDataTrack
 CDataTrack (CRenderingContext *r_cntx)
 
virtual ~CDataTrack ()
 
virtual void DeleteAllJobs ()
 
virtual bool AllJobsFinished () const
 
void OnAJNotification (CEvent *evt)
 event handlers for job notification event. More...
 
void OnAJProgress (CEvent *evt)
 
void SetVisRange (const TSeqRange &range)
 
virtual void Update (bool layout_only)
 Update content and layout including the bounding box. More...
 
- Public Member Functions inherited from CGlyphContainer
 CGlyphContainer (CRenderingContext *r_cntx)
 
virtual ~CGlyphContainer ()
 
void Add (CSeqGlyph *obj)
 Append a layout object to the end. More...
 
void SetObjects (const CLayoutGroup::TObjectList &objs)
 
virtual void SetComments (const string &comment_str)
 set comments. More...
 
virtual void SetHighlights (const string &hl_str)
 set a list of 'object' need to be highlighted. More...
 
void SetCommentGlyphs (const CSeqGlyph::TObjects &objs, CRef< CCommentConfig > config)
 
void ResetCommentGlyph ()
 
void SetLabelGlyphs (const CSeqGlyph::TObjects &objs, CRef< CCommentConfig > config)
 
void ResetLabelGlyph ()
 
const THighlightsGetHighlights () const
 
const TKeyHighlightsGetHighlightsByKey () const
 
CLayoutGroupSetGroup ()
 
const CLayoutGroupGetGroup () const
 
CLayoutGroup::TObjectListSetChildren ()
 
const CLayoutGroup::TObjectListGetChildren () const
 
bool Empty () const
 
void SetLayoutPolicy (ILayoutPolicy *policy)
 Set policy on how to deploy the layout of its children. 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 bool Accept (IGlyphVisitor *visitor)
 Interface for accepting an IGlyphVisitor. More...
 
- Public Member Functions inherited from CLayoutTrack
 CLayoutTrack (CRenderingContext *r_cntx)
 
virtual ~CLayoutTrack ()
 
void LoadProfile (const string &profile_str)
 set track profile and load settings. More...
 
void SaveProfile ()
 
void SetProfile (const string &preset_style)
 CLayoutTrack inline method implmentation. More...
 
const stringGetProfile () const
 
virtual string GetFullTitle () const
 get a more meaningful title. More...
 
string GetTitle () const
 get the track title. More...
 
const TTrackErrorStatusGetErrorStatus () const
 
void SetErrorStatus (const TTrackErrorStatus &ErrorStatus)
 
bool isInErrorStatus () const
 
bool isRmtBased () const
 
bool isRemotePath () const
 
void MouseOut ()
 
bool OnMotion (const TModelPoint &pt)
 
bool GetShowTitle () const
 
void SetShowTitle (bool flag)
 
void SetConfig (CRef< CSeqGraphicConfig > conf)
 
int GetIndent () const
 
void SetIndent (int indent)
 
void SetMsg (const string &msg)
 
void SetParentTrack (CLayoutTrack *parent)
 
CLayoutTrackGetParentTrack ()
 
const CLayoutTrackGetParentTrack () const
 
bool IsOn () const
 
bool IsExpanded () const
 
bool IsMovable () const
 
bool IsCollapsible () const
 
void SetShow (bool shown)
 set the flag only. More...
 
void SetExpanded (bool f)
 
void SetShowFrame (bool show)
 
void MoveTo (TModelUnit y)
 
void SetTrackAttr (TTrackAttrFlags flags)
 
void SetTitle (const string &label, const string &default_title=NcbiEmptyString)
 
void SetIsBlast (bool isBlast)
 
void SetHost (ILayoutTrackHost *host)
 
void SetOrder (int order)
 
int GetOrder () const
 
void SetId (const string &id)
 
const stringGetId () const
 
void CloseMe ()
 close this track. More...
 
void ShowMe ()
 
void Expand (bool expand)
 Collapse or expand the track. More...
 
virtual bool OnLeftDown (const TModelPoint &p)
 
virtual bool OnLeftDblClick (const TModelPoint &p)
 
virtual bool NeedTooltip (const TModelPoint &p, ITooltipFormatter &tt, string &t_title) const
 Check if need to show tooltip. More...
 
virtual void GetTooltip (const TModelPoint &p, ITooltipFormatter &tt, string &t_title) const
 Get the tooltip if available. More...
 
- Public Member Functions inherited from CSeqGlyph
 CSeqGlyph ()
 
virtual ~CSeqGlyph ()
 
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 OnLeftUp (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...
 
- Public Member Functions inherited from CEventHandler
 CEventHandler ()
 CEventHandler. More...
 
virtual ~CEventHandler ()
 
virtual void AddListener (CEventHandler *listener, int pool_name=ePool_Default)
 Add a listener. More...
 
virtual void RemoveListener (CEventHandler *listener)
 Remove a listener. More...
 
virtual void RemoveAllListeners (void)
 
virtual bool HasListener (CEventHandler *listener, int pool_name=ePool_Default) const
 returns "true" if the given listener belongs to the specified pool More...
 
virtual const TListenersGetListeners (int pool_name=ePool_Default) const
 returns a set of listeners fro the specified pool More...
 
virtual bool OnEvent (CEvent *evt)
 Processes en event. Returns "true" if event has been processed. More...
 
virtual bool Dispatch (CEvent *evt, EDispatch disp_how=eDispatch_Default, int pool_name=ePool_Default)
 Dispatches an event to the listeners (but does not handle it). More...
 
virtual bool Send (CEvent *evt, EDispatch disp_how=eDispatch_Default, int pool_name=ePool_Default)
 Sends an event synchronously. More...
 
virtual bool Send (CEvent *evt, int pool_name)
 
void Post (CRef< CEvent > evt, EDispatch disp_how=eDispatch_Default, int pool_name=ePool_Default)
 Handles an event asynchronously (process and/or dispatch). More...
 
- Public Member Functions inherited from ILegendProvider
virtual ~ILegendProvider ()
 
- Public Member Functions inherited from IDroppable
virtual ~IDroppable ()
 

Static Public Attributes

static const string kOverlayed = "_overlayed"
 
- 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

objects::SAnnotSelector & x_GetAnnotSelector ()
 
CSGGraphDSx_GetGraphDS ()
 
bool CreateOverlay (vector< CRef< CGraphTrack >> &tracks)
 
CLayoutTrack virtual methods overloading.
virtual void x_LoadSettings (const string &preset_style, const TKeyValuePairs &settings)
 load the track settings. More...
 
virtual void x_SaveSettings (const string &preset_style)
 save part of settings to a profile string. More...
 
virtual void x_OnIconClicked (TIconID id)
 Mouse left-click event handler on an icon. More...
 
virtual void x_OnLayoutChanged ()
 update the layout. More...
 
CDataTrack pure virtual interfaces
virtual void x_UpdateData ()
 update track content. More...
 
virtual void x_OnJobCompleted (CAppJobNotification &notify)
 
CGlyphContainerpure virtual interfaces
virtual void x_UpdateBoundingBox ()
 Update the bounding box assuming children's sizes are fixed if any. More...
 
virtual void x_RenderContent () const
 The content rendering must be implemented in the derived layout tracks. More...
 
- Protected Member Functions inherited from CDataTrack
 DECLARE_EVENT_MAP ()
 
virtual void x_Expand (bool expand)
 Collapse or expand the track. More...
 
void x_UpdateLayout ()
 
const TSeqRangex_GetVisRange () const
 
virtual bool x_IsJobNeeded (CAppJobDispatcher::TJobID id) const
 
virtual void x_OnJobFailed (CAppJobNotification &notify)
 
virtual void x_OnAllJobsFinished ()
 
- Protected Member Functions inherited from CGlyphContainer
virtual string x_GetHistMsg () const
 Histogram configuration (linear, log, etc) is also on the title bar but multiple track types can have histograms, so we use virtual functinons. More...
 
virtual bool x_Empty () const
 
virtual void x_ClearContent ()
 
- Protected Member Functions inherited from CLayoutTrack
virtual void x_Draw () const
 The default renderer for this layout object. More...
 
virtual bool x_ShowTitle () const
 Need to preserve title space and show the title. More...
 
TModelUnit x_GetTBHeight () const
 Get title bar height including margin. More...
 
CConstRef< CSeqGraphicConfigx_GetGlobalConfig () const
 Method for getting global configuration from rendering context. More...
 
void x_OnLayoutChanged ()
 update the layout. More...
 
virtual void x_GetTBRect (TModelRect &rc) const
 Get title bar rectange exclude top margin. More...
 
virtual void x_RenderProgressBar () const
 Method for rendering the job loading or layout generating progress. More...
 
virtual void x_RenderTitleBar () const
 Method for rendering the track title bar. More...
 
virtual void x_RenderIcon (TIconID id, bool highlighted, bool lite_version=false) const
 Render track icons. More...
 
virtual int x_GetIconState (TIconID id) const
 Get current status for a given button. More...
 
void x_RegisterIcon (const SIconInfo &icon)
 register track icons. More...
 
void x_DeregisterIcon (TIconID id)
 deregister an icon if already registered. More...
 
void x_EnableIcon (TIconID id, bool enabled)
 Enable/disable an existing icon. More...
 
void x_ShowIcon (TIconID id, bool shown)
 Show/hide an existing icon. More...
 
int x_HitIconTest (const TModelPoint &p) const
 hit any icon?. More...
 
bool x_HitTitleBar (const TModelPoint &p) const
 hit the title bar?. More...
 
void x_SetStatus (const string &msg, int progress)
 
void x_SetStartStatus ()
 
void x_SetFinishStatus ()
 
bool x_IsNCBITrack () const
 Indicates whether the track is NCBI track. 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...
 
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...
 
- Protected Member Functions inherited from CEventHandler
virtual const SEvtMapGetEventMap () const
 
void x_DeclareDead ()
 Removes itself unavailable for async event delivery. More...
 
void x_AddListenerToPool (CEventHandler *listener, int pool_name)
 

Static Protected Member Functions

static CNetICacheClient s_InitICache ()
 
static CNetICacheClients_GetICacheInstance ()
 
- Static Protected Member Functions inherited from CLayoutTrack
static void RegisterCommonIconImages ()
 register images for the common icons. More...
 
static bool InitIconTextures ()
 initialize OpenGL ttexture objects for icons. More...
 

Private Member Functions

void x_OnSettingsIconClicked ()
 
void x_InitGrid ()
 
void x_CollectAllGraphs (vector< CRef< CHistogramGlyph >> &graphs) const
 
prohibited copy constructor and assignment operator.
 CGraphTrack (const CGraphTrack &)
 
CGraphTrackoperator= (const CGraphTrack &)
 

Static Private Member Functions

static ELayout x_LayoutStrToValue (const string &layout)
 
static string x_LayoutValueToStr (ELayout layout)
 

Private Attributes

string m_AnnotName
 
CRef< CSGGraphDSm_DS
 
objects::SAnnotSelector m_Sel
 
bool m_FixedScale
 Dynamic or fixed graph scale. More...
 
CSGGraphDS::TAxisLimits m_YLimits
 Graph y limits stored when FixedScale is set. More...
 
CRef< CHistogramGlyphm_Grid
 
ELayout m_Layout
 

Static Private Attributes

static CTrackTypeInfo m_TypeInfo
 

Friends

class CGraphTrackFactory
 

Additional Inherited Members

- Static Public Member Functions inherited from CLayoutTrack
static void RegisterIconImage (const TIconAlias &key, const string &img_file)
 register the image for an icon. 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 Member Functions inherited from CEventHandler
static bool HandlePostRequest ()
 
static void ClearPostQueue ()
 erases all events from the queue More...
 
static void DestroyPostQueue ()
 
- Protected Types inherited from CLayoutTrack
enum  EIconID {
  eIcon_Close = 0 , eIcon_Expand , eIcon_Content , eIcon_Layout ,
  eIcon_Settings , eIcon_Help , eIcon_MaxTrackIconID = 100
}
 Icon id used in layout track. More...
 
typedef int TIconID
 use int as TIconID instead of EIconID. More...
 
typedef string TIconAlias
 the icon alias used as a key More...
 
typedef vector< SIconInfoTIcons
 
- Protected Attributes inherited from CGlyphContainer
CLayoutGroup m_Group
 
CRef< CSimpleLayoutm_Simple
 
CRef< CInlineLayoutm_Inline
 
CRef< CLayeredLayoutm_Layered
 
- Protected Attributes inherited from CLayoutTrack
int m_Order
 track order number More...
 
string m_Id
 track identifier More...
 
bool m_On
 is this track shown More...
 
bool m_ShowFrame
 need to draw frame, not title More...
 
bool m_Expanded
 is this track in expanded state More...
 
TIcons m_Icons
 registered icon info More...
 
int m_HighlightedIcon
 the highlighted icon index More...
 
TTrackAttrFlags m_Attrs
 various track attributes More...
 
ILayoutTrackHostm_LTHost
 Top level host owning the tracks. More...
 
string m_Title
 track title More...
 
bool m_isBlast {false}
 true if the track is known to be generated and uploaded by BLAST More...
 
string m_DefaultTitle
 Default track title. More...
 
string m_Msg
 special message need to show on title bar More...
 
int m_Progress
 any job progress index (0 - 100) More...
 
int m_IndentLevel
 track hierachy indentation level. More...
 
TTrackErrorStatus m_ErrorStatus
 
CRef< CSeqGraphicConfigm_gConfig
 global configuration. More...
 
string m_Profile = "Default"
 track setting profile 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...
 
- Protected Attributes inherited from CEventHandler
TPools m_Pools
 
- Static Protected Attributes inherited from CEventHandler
static const SEvtMap sm_EvtMap
 

Detailed Description

CGraphTrack –.

Definition at line 51 of file graph_track.hpp.

Member Enumeration Documentation

◆ ELayout

Enumerator
eLayout_Layered 
eLayout_Overlay 
eLayout_Overlayed 

Definition at line 59 of file graph_track.hpp.

Constructor & Destructor Documentation

◆ CGraphTrack() [1/2]

CGraphTrack::CGraphTrack ( CSGGraphDS ds,
CRenderingContext r_cntx 
)

◆ ~CGraphTrack()

CGraphTrack::~CGraphTrack ( )
virtual

◆ CGraphTrack() [2/2]

CGraphTrack::CGraphTrack ( const CGraphTrack )
private

Member Function Documentation

◆ CanDrop()

bool CGraphTrack::CanDrop ( CRef< CLayoutTrack > &  track)
virtual

Implements IDroppable.

Definition at line 1392 of file graph_track.cpp.

References gt.

◆ CreateOverlay()

bool CGraphTrack::CreateOverlay ( vector< CRef< CGraphTrack >> &  tracks)
protected

◆ Drop()

bool CGraphTrack::Drop ( CRef< CLayoutTrack > &  track)
virtual

Implements IDroppable.

Definition at line 1398 of file graph_track.cpp.

References CreateOverlay(), gt, and Ref().

◆ GetAnnot()

const string & CGraphTrack::GetAnnot ( void  ) const
inline

Definition at line 222 of file graph_track.hpp.

References m_AnnotName.

◆ GetDataSource() [1/2]

CRef< CSGGenBankDS > CGraphTrack::GetDataSource ( )
virtual

Method for accessing the data source.

Implements CDataTrack.

Definition at line 137 of file graph_track.cpp.

References CRef< C, Locker >::GetPointer(), and m_DS.

◆ GetDataSource() [2/2]

CConstRef< CSGGenBankDS > CGraphTrack::GetDataSource ( void  ) const
virtual

Implements CDataTrack.

Definition at line 143 of file graph_track.cpp.

References CRef< C, Locker >::GetPointer(), and m_DS.

◆ GetHTMLActiveAreas()

void CGraphTrack::GetHTMLActiveAreas ( TAreaVector ) const
virtual

Get html active areas.

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

Reimplemented from CGlyphContainer.

Definition at line 149 of file graph_track.cpp.

References eLayout_Overlay, eLayout_Overlayed, CGlyphContainer::GetHTMLActiveAreas(), and m_Layout.

◆ GetLegend()

void CGraphTrack::GetLegend ( const CTempTrackProxy track_proxy,
objects::CTrackConfig::TLegend &  legend 
) const
virtual

◆ GetTypeInfo()

const CTrackTypeInfo & CGraphTrack::GetTypeInfo ( void  ) const
virtual

Reimplemented from CGlyphContainer.

Reimplemented in CSeqTableGraphTrack.

Definition at line 132 of file graph_track.cpp.

References m_TypeInfo.

◆ InitHTMLActiveArea()

CHTMLActiveArea * CGraphTrack::InitHTMLActiveArea ( TAreaVector p_areas) const
virtual

◆ operator=()

CGraphTrack& CGraphTrack::operator= ( const CGraphTrack )
private

◆ s_GetICacheInstance()

CNetICacheClient & CGraphTrack::s_GetICacheInstance ( )
staticprotected

Definition at line 236 of file graph_track.cpp.

References s_InitICache().

Referenced by x_LoadSettings(), and x_OnJobCompleted().

◆ s_InitICache()

CNetICacheClient CGraphTrack::s_InitICache ( )
staticprotected

◆ SetAnnot()

void CGraphTrack::SetAnnot ( const string annot)

◆ SetLayout()

void CGraphTrack::SetLayout ( ELayout  layout)

◆ x_CollectAllGraphs()

void CGraphTrack::x_CollectAllGraphs ( vector< CRef< CHistogramGlyph >> &  graphs) const
private

◆ x_GetAnnotSelector()

objects::SAnnotSelector & CGraphTrack::x_GetAnnotSelector ( )
inlineprotected

Definition at line 228 of file graph_track.hpp.

References m_Sel.

Referenced by CSeqTableGraphTrack::CSeqTableGraphTrack().

◆ x_GetGraphDS()

CSGGraphDS & CGraphTrack::x_GetGraphDS ( )
inlineprotected

Definition at line 234 of file graph_track.hpp.

References m_DS.

◆ x_InitGrid()

void CGraphTrack::x_InitGrid ( )
private

◆ x_LayoutStrToValue()

CGraphTrack::ELayout CGraphTrack::x_LayoutStrToValue ( const string layout)
staticprivate

Definition at line 242 of file graph_track.cpp.

References eLayout_Layered, eLayout_Overlay, and NStr::EqualNocase().

Referenced by x_LoadSettings().

◆ x_LayoutValueToStr()

string CGraphTrack::x_LayoutValueToStr ( CGraphTrack::ELayout  layout)
staticprivate

Definition at line 251 of file graph_track.cpp.

References eLayout_Layered, and eLayout_Overlay.

Referenced by x_SaveSettings().

◆ x_LoadSettings()

void CGraphTrack::x_LoadSettings ( const string preset_style,
const TKeyValuePairs settings 
)
protectedvirtual

load the track settings.

By default, it does nothing.

Parameters
preset_stylea preset setting style name
settingsa list of track-specific setting in a form of key-value pair.

Reimplemented from CLayoutTrack.

Definition at line 265 of file graph_track.cpp.

References _ASSERT, CHistParamsManager::AddSettings(), color, CTrackConfigUtils::DecodeValueRange(), NStr::EqualNocase(), ERR_POST, Error(), eSerial_AsnBinary, CHistParams::eSmearBar, NStr::fConvErr_NoThrow, CRWStreambuf::fOwnReader, CRgbaColor::FromString(), CSeqGraphicConfig::GetCgiMode(), CUser_field_Base::GetData(), CHistParamsManager::GetDefHistParams(), COpenRange< Position >::GetEmptyFrom(), COpenRange< Position >::GetEmptyTo(), CUser_object::GetField(), CRange_Base::GetFrom(), CHistParamsManager::GetHistParams(), CSeqGraphicConfig::GetHistParamsManager(), CNetICacheClient::GetReadStream(), CUser_field_Base::C_Data::GetReal(), CRange_Base::GetTo(), CNetICacheClient::HasBlobs(), CUser_object::HasField(), CHistParamsManager::HasSettings(), ITERATE, ncbi::grid::netcache::search::fields::key, kNegColor, kNumBins, kOutlierColor, kScale, kSDeviationThreshold, kStoredScale, kValueRange, CRgbaColor::Lighten(), LOG_POST, m_AnnotName, CHistParams::m_bgColor, CHistParams::m_ClipOutliers, SCustomizedHistSettings::m_Color, CHistParams::m_DrawBg, CHistParams::m_fgColor, CHistParams::m_fgNegColor, CHistParams::m_FitStep, m_FixedScale, CLayoutTrack::m_gConfig, CHistParams::m_Height, SCustomizedHistSettings::m_Height, m_Layout, CHistParams::m_NumBins, CHistParams::m_OutlierColor, CHistParams::m_RangeAutoscale, CHistParams::m_Scale, CHistParams::m_SDeviationThreshold, CHistParams::m_SmearColorMax, CHistParams::m_SmearColorMin, CHistParams::m_SmoothCurve, CHistParams::m_StoredScale, CHistParams::m_Type, SCustomizedHistSettings::m_Type, CHistParams::m_ValueRange, m_YLimits, CSGAnnotJob::TAxisLimits::max, max(), CSGAnnotJob::TAxisLimits::min, min(), NcbiEmptyString, CObjectIStream::Open(), Ref(), CRef< C, Locker >::Reset(), s_GetCacheKey(), s_GetICacheInstance(), CHistParams::ScaleStrToValue(), COpenRange< Position >::Set(), CRgbaColor::SetAlpha(), CRange_Base::SetFrom(), CRange_Base::SetTo(), NStr::StringToBool(), NStr::StringToInt(), NStr::StringToNonNegativeInt(), CHistParams::TypeStrToValue(), and x_LayoutStrToValue().

◆ x_OnIconClicked()

void CGraphTrack::x_OnIconClicked ( TIconID  id)
protectedvirtual

Mouse left-click event handler on an icon.

In this class, only clicks on close and expand icons are handled. Any other icons are very likely track-specific, so they need to be handled in the derived tracks.

Reimplemented from CLayoutTrack.

Definition at line 487 of file graph_track.cpp.

References CLayoutTrack::eIcon_Settings, CLayoutTrack::x_OnIconClicked(), and x_OnSettingsIconClicked().

◆ x_OnJobCompleted()

void CGraphTrack::x_OnJobCompleted ( CAppJobNotification notify)
protectedvirtual

Implements CDataTrack.

Definition at line 507 of file graph_track.cpp.

References _ASSERT, CGlyphContainer::Add(), CUser_object::AddField(), CLayoutGroup::Clear(), CSGGenBankDS::ClearJobID(), count, eLayout_Overlay, eLayout_Overlayed, CHistogramGlyph::eMode_Overlay, CHistogramGlyph::eMode_Single, ERR_POST, Error(), eSerial_AsnBinary, CRWStreambuf::fOwnWriter, CHistogramGlyph::GetAnnotName(), CHistogramGlyph::GetAxisMax(), CHistogramGlyph::GetAxisMin(), CSeqGraphicConfig::GetCgiMode(), CAppJobNotification::GetJobID(), CRef< C, Locker >::GetPointer(), CAppJobNotification::GetResult(), CHistogramGlyph::GetTitle(), CNetICacheClient::GetWriteStream(), i, ncbi::grid::netcache::search::fields::key, kOverlayed, label, m_AnnotName, m_DS, CLayoutTrack::m_gConfig, CGlyphContainer::m_Layered, m_Layout, CGlyphContainer::m_Simple, CLayoutTrack::m_Title, m_YLimits, CSGAnnotJob::TAxisLimits::max, max(), CSGAnnotJob::TAxisLimits::min, min(), msg(), NcbiEmptyString, NON_CONST_ITERATE, CObjectOStream::Open(), CLayoutGroup::PushBack(), Ref(), result, s_GetCacheKey(), s_GetICacheInstance(), CHistogramGlyph::SetAnnotName(), CHistogramGlyph::SetConfig(), CHistogramGlyph::SetDesc(), CGlyphContainer::SetGroup(), CGlyphContainer::SetLayoutPolicy(), CLayoutGroup::SetLayoutPolicy(), CLayoutTrack::SetMsg(), CGlyphContainer::SetObjects(), CHistogramGlyph::SetRenderingMode(), CUser_object_Base::SetType(), NStr::SizetToString(), NStr::StartsWith(), CLayoutTrack::x_GetGlobalConfig(), and CDataTrack::x_UpdateLayout().

◆ x_OnLayoutChanged()

void CGraphTrack::x_OnLayoutChanged ( )
protectedvirtual

◆ x_OnSettingsIconClicked()

void CGraphTrack::x_OnSettingsIconClicked ( )
private

◆ x_RenderContent()

void CGraphTrack::x_RenderContent ( ) const
protectedvirtual

The content rendering must be implemented in the derived layout tracks.

Reimplemented from CGlyphContainer.

Definition at line 1298 of file graph_track.cpp.

References CHistogramGlyph::DrawGrid(), eLayout_Overlay, COpenRange< Position >::Empty(), CSeqGlyph::GetHeight(), CRenderingContext::IntersectVisible(), CSeqGlyph::m_Context, m_Grid, m_Layout, and CGlyphContainer::x_RenderContent().

◆ x_SaveSettings()

void CGraphTrack::x_SaveSettings ( const string preset_style)
protectedvirtual

save part of settings to a profile string.

Only the potential settings changed by users will be saved.

Reimplemented from CLayoutTrack.

Definition at line 475 of file graph_track.cpp.

References NStr::BoolToString(), NStr::Join(), kDefaultFixedScale, kDefaultLayout, m_FixedScale, m_Layout, NcbiEmptyString, CLayoutTrack::SetProfile(), and x_LayoutValueToStr().

◆ x_UpdateBoundingBox()

void CGraphTrack::x_UpdateBoundingBox ( )
protectedvirtual

◆ x_UpdateData()

void CGraphTrack::x_UpdateData ( )
protectedvirtual

Friends And Related Function Documentation

◆ CGraphTrackFactory

friend class CGraphTrackFactory
friend

Definition at line 56 of file graph_track.hpp.

Member Data Documentation

◆ kOverlayed

const string CGraphTrack::kOverlayed = "_overlayed"
static

◆ m_AnnotName

string CGraphTrack::m_AnnotName
private

◆ m_DS

CRef<CSGGraphDS> CGraphTrack::m_DS
private

◆ m_FixedScale

bool CGraphTrack::m_FixedScale
private

Dynamic or fixed graph scale.

By default, the graph scale is a dynamic value which is updated within the visible range.

Definition at line 156 of file graph_track.hpp.

Referenced by x_LoadSettings(), x_OnSettingsIconClicked(), x_SaveSettings(), and x_UpdateData().

◆ m_Grid

CRef<CHistogramGlyph> CGraphTrack::m_Grid
private

◆ m_Layout

ELayout CGraphTrack::m_Layout
private

◆ m_Sel

objects::SAnnotSelector CGraphTrack::m_Sel
private

Definition at line 151 of file graph_track.hpp.

Referenced by CGraphTrack(), SetAnnot(), x_GetAnnotSelector(), and x_UpdateData().

◆ m_TypeInfo

CTrackTypeInfo CGraphTrack::m_TypeInfo
staticprivate

◆ m_YLimits

CSGGraphDS::TAxisLimits CGraphTrack::m_YLimits
private

Graph y limits stored when FixedScale is set.

Definition at line 158 of file graph_track.hpp.

Referenced by CGraphTrack(), x_LoadSettings(), x_OnJobCompleted(), and x_UpdateData().


The documentation for this class was generated from the following files:
Modified on Fri Sep 20 14:57:07 2024 by modify_doxy.py rev. 669887