Inheritance diagram for HPS.HCA.ModelTreeItem:
HPS.Sprocket HPS.Object

Classes

class  ModelTreeItemUnknown
 

Public Member Functions

abstract HPS.HCA.ModelTreeItem AddChild (Int64 in_node_id)
 
virtual void Assign (HPS.HCA.ModelTreeItem in_that)
 
virtual void Collapse ()
 
override void Dispose ()
 
delegate void DtorDelegate (IntPtr cPtr)
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.HCA.ModelTreeItem in_that)
 
virtual void Expand ()
 
override int GetHashCode ()
 
HPS.HCA.ModelTree.ItemType GetItemType ()
 
UInt64 GetNodeId ()
 
string GetTitle ()
 
HPS.HCA.ModelTree GetTree ()
 
bool HasChildren ()
 
void Hide ()
 
void Highlight (HPS.HighlightOptionsKit in_highlight_options)
 
bool IsExpanded ()
 
bool IsHidden ()
 
bool IsHighlighted ()
 
void Isolate ()
 
 ModelTreeItem ()
 
 ModelTreeItem (HPS.HCA.ModelTreeItem in_that)
 
 ModelTreeItem (HPS.HCA.ModelTree in_tree, HPS.HCA.Model in_hca_model)
 
 ModelTreeItem (HPS.HCA.ModelTree in_tree, Int64 in_node_id)
 
override HPS.Type ObjectType ()
 
virtual void OnHighlightUnhighlight ()
 
virtual void OnShowHide ()
 
delegate void RemoveCacheItemDelegate (IntPtr cPtr)
 
bool RequestProperties (out UInt32 out_request_id)
 
void Show ()
 
void Unhighlight ()
 
void Zoom ()
 
- Public Member Functions inherited from HPS.Sprocket
Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Static Public Member Functions

static bool operator!= (HPS.HCA.ModelTreeItem a, HPS.HCA.ModelTreeItem b)
 
static bool operator== (HPS.HCA.ModelTreeItem a, HPS.HCA.ModelTreeItem b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
virtual bool DerivedClassHasMethod (string methodName, System.Type[] methodTypes)
 
virtual bool IsUserDerived ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Protected Attributes

HandleRef sptr
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Static Protected Attributes

static Dictionary< IntPtr, ModelTreeItemcachedObjects = new Dictionary<IntPtr, ModelTreeItem>()
 
static Dictionary< IntPtr, WeakReference > cachedWeakRefs = new Dictionary<IntPtr, WeakReference>()
 
static ReaderWriterLockSlim mapLock = new ReaderWriterLockSlim(LockRecursionPolicy.SupportsRecursion)
 

Detailed Description

The ModelTreeItem class is a smart pointer which corresponds to an item or node in a tree object in a GUI toolkit, e.g., a TreeViewItem in WPF or an HTREEITEM in MFC. This class must be derived from to facilitate tree creation in the various GUI toolkits. It is used to represent items in a model browser.

Constructor & Destructor Documentation

◆ ModelTreeItem() [1/4]

HPS.HCA.ModelTreeItem.ModelTreeItem ( )
inline

The default constructor creates an uninitialized ModelTreeItem object. The Type() function will return Type.None.

◆ ModelTreeItem() [2/4]

HPS.HCA.ModelTreeItem.ModelTreeItem ( HPS.HCA.ModelTreeItem  in_that)
inline

The copy constructor creates a ModelTreeItem object that shares the underlying smart-pointer of the source ModelTreeItem.

Parameters
in_thatThe source ModelTreeItem to copy.

◆ ModelTreeItem() [3/4]

HPS.HCA.ModelTreeItem.ModelTreeItem ( HPS.HCA.ModelTree  in_tree,
HPS.HCA.Model  in_hca_model 
)
inline

This constructor creates a ModelTreeItem suitable for acting as a root in a ModelTree.

Parameters
in_treeA pointer to the ModelTree which will contain this ModelTreeItem
in_hca_modelThe HCA.Model which will be assigned to this ModelTreeItem.

◆ ModelTreeItem() [4/4]

HPS.HCA.ModelTreeItem.ModelTreeItem ( HPS.HCA.ModelTree  in_tree,
Int64  in_node_id 
)
inline

This constructor creates a ModelTreeItem which is not suitable for acting as a root in a ModelTree, but is suitable to be a ModelTreeItem under the root of the ModelTree. This constructor should be the one invoked in the overridden AddChild function.

Parameters
in_treeA pointer to the ModelTree which will contain this ModelTreeItem.
in_node_idThe node ID to be associated with this ModelTreeItem.

Member Function Documentation

◆ AddChild()

abstract HPS.HCA.ModelTreeItem HPS.HCA.ModelTreeItem.AddChild ( Int64  in_node_id)
pure virtual

This function is used to create a new ModelTreeItem to be the child of this ModelTreeItem. You will need to implement this function in your class which derives from HCA.ModelTreeItem. This function will be invoked if this ComponentTreeItem has children and Expand has been invoked on it. This function should contain any necessary calls to GUI toolkits to create the appropriate GUI elements. Additionally, since this function requires the creation of a derived ModelTreeItem, that derived ModelTreeItem should use the base constructor which is appropriate for creating non-root items.

Parameters
in_node_idThe node ID to be associated with the ModelTreeItem being added to the ModelTree.

◆ Assign()

virtual void HPS.HCA.ModelTreeItem.Assign ( HPS.HCA.ModelTreeItem  in_that)
inlinevirtual

Share the underlying smart-pointer of the ModelTreeItem source.

Parameters
in_thatThe ModelTreeItem source of the assignment.
Returns
A reference to this ModelTreeItem.

◆ Collapse()

virtual void HPS.HCA.ModelTreeItem.Collapse ( )
inlinevirtual

This function should be invoked when this ModelTreeItem needs to collapse. If this function is overridden, the overriding function should invoke this base function. Additionally, this function will always release all children for this ModelTreeItem when invoked.

◆ Equals()

bool HPS.HCA.ModelTreeItem.Equals ( HPS.HCA.ModelTreeItem  in_that)
inline

Check if the source ModelTreeItem points to the same underlying impl as this ModelTreeItem.

Parameters
in_thatThe source ModelTreeItem to compare to this ModelTreeItem.
Returns
true if the objects reference the same underlying data, false otherwise.

◆ Expand()

virtual void HPS.HCA.ModelTreeItem.Expand ( )
inlinevirtual

This function should be invoked when this ModelTreeItem needs to expand. If this function is overridden, the overriding function should invoke this base function. Additionally, this function will always repopulate the children for this ModelTreeItem when invoked.

◆ GetItemType()

HPS.HCA.ModelTree.ItemType HPS.HCA.ModelTreeItem.GetItemType ( )
inline

Gets the item type for this ModelTreeItem. This is used to determine what type of data this ModelTreeItem represents in the ModelTree.

Returns
The item type for this ModelTreeItem.

◆ GetNodeId()

UInt64 HPS.HCA.ModelTreeItem.GetNodeId ( )
inline

Returns the HCA node ID associated with this ModelTreeItem

Returns
The HCA node ID associated with this ModelTreeItem .

◆ GetTitle()

string HPS.HCA.ModelTreeItem.GetTitle ( )
inline

Gets the title for this ModelTreeItem. This is the text that should be displayed for this ModelTreeItem in the ModelTree.

Returns
The title for this ModelTreeItem.

◆ GetTree()

HPS.HCA.ModelTree HPS.HCA.ModelTreeItem.GetTree ( )
inline

Gets the ModelTree associated with this ModelTreeItem. This provides a means of accessing the derived ModelTree by this ModelTreeItem if necessary.

Returns
The ModelTree associated with this ModelTreeItem.

◆ HasChildren()

bool HPS.HCA.ModelTreeItem.HasChildren ( )
inline

Indicates whether this ModelTreeItem has any children.

Returns
true if this ModelTreeItem has children, false otherwise.

◆ Hide()

void HPS.HCA.ModelTreeItem.Hide ( )
inline

Hides this ModelTreeItem it isn't already. Geometry associated with a hidden ModelTreeItem becomes invisible. Calling this function will result in a call to OnShowHide after the hide operation has taken place.

◆ Highlight()

void HPS.HCA.ModelTreeItem.Highlight ( HPS.HighlightOptionsKit  in_highlight_options)
inline

Highlights this ModelTreeItem using the options specified. Calling this function will result in a call to OnHighlightUnhighlight after the highlight operation has taken place.

◆ IsExpanded()

bool HPS.HCA.ModelTreeItem.IsExpanded ( )
inline

Indicates whether this ModelTreeItem is currently expanded.

Returns
true if this ModelTreeItem is expanded, false otherwise.

◆ IsHidden()

bool HPS.HCA.ModelTreeItem.IsHidden ( )
inline

Indicates whether this ModelTreeItem is currently hidden.

Returns
true if this ModelTreeItem is hidden, false otherwise.

◆ IsHighlighted()

bool HPS.HCA.ModelTreeItem.IsHighlighted ( )
inline

Indicates whether this ModelTreeItem is currently highlighted.

Returns
true if this ModelTreeItem is highlighted, false otherwise.

◆ Isolate()

void HPS.HCA.ModelTreeItem.Isolate ( )
inline

Shows this ModelTreeItem and hides every other nodes in the tree, causing this item to become the only one visible. The camera will zoom to the isolated item. Calling this function will result in a call to OnShowHide for the item which is isolated, after the isolate operation has taken place.

◆ ObjectType()

override HPS.Type HPS.HCA.ModelTreeItem.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Object.

◆ OnHighlightUnhighlight()

virtual void HPS.HCA.ModelTreeItem.OnHighlightUnhighlight ( )
inlinevirtual

This function will be invoked when this item becomes highlighted or unhighlighted. If you want something to happen when an item's highlight state changes you should provide an implementation for this function in your class which derives from HCA.ModelTreeItem. A common usage for this function is to make the text associated with highlighted items bold to indicate to users whether the item is highlighted or not at a glance.

◆ OnShowHide()

virtual void HPS.HCA.ModelTreeItem.OnShowHide ( )
inlinevirtual

This function will be invoked when this item becomes shown or hidden. If you want something to happen when an item becomes shown or hidden you should provide an implementation for this function in your class which derives from HCA.ModelTreeItem. A common usage for this function is to change the icon associated with the node to indicate to users whether the item is shown or hidden at a glance.

◆ Show()

void HPS.HCA.ModelTreeItem.Show ( )
inline

Shows this ModelTreeItem it isn't already visible. Geometry associated with a shown ModelTreeItem becomes visible. Calling this function will result in a call to OnShowHide after the show operation has taken place.

◆ Unhighlight()

void HPS.HCA.ModelTreeItem.Unhighlight ( )
inline

Removes all highlights from this ModelTreeItem. Calling this function will result in a call to OnHighlightUnhighlight after the unhighlight operation has taken place.

◆ Zoom()

void HPS.HCA.ModelTreeItem.Zoom ( )
inline

Smoothly zooms the camera to focus on this item. The transition lasts half a second.


The documentation for this class was generated from the following file:
  • internals/hps_sprk_hca/source/cs/HPS.HCA.cs