|
class | ModelTreeItemUnknown |
|
|
override void | deleteCptr () |
|
virtual bool | DerivedClassHasMethod (string methodName, System.Type[] methodTypes) |
|
virtual bool | IsUserDerived () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
HandleRef | sptr |
|
bool | cMemOwn |
|
HandleRef | cptr |
|
|
static Dictionary< IntPtr, ModelTreeItem > | cachedObjects = new Dictionary<IntPtr, ModelTreeItem>() |
|
static Dictionary< IntPtr, WeakReference > | cachedWeakRefs = new Dictionary<IntPtr, WeakReference>() |
|
static ReaderWriterLockSlim | mapLock = new ReaderWriterLockSlim(LockRecursionPolicy.SupportsRecursion) |
|
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.
◆ 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]
The copy constructor creates a ModelTreeItem object that shares the underlying smart-pointer of the source ModelTreeItem.
- Parameters
-
◆ ModelTreeItem() [3/4]
◆ ModelTreeItem() [4/4]
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
-
◆ AddChild()
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
-
◆ Assign()
◆ 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()
Check if the source ModelTreeItem points to the same underlying impl as this ModelTreeItem.
- Parameters
-
- 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()
◆ GetNodeId()
UInt64 HPS.HCA.ModelTreeItem.GetNodeId |
( |
| ) |
|
|
inline |
◆ GetTitle()
string HPS.HCA.ModelTreeItem.GetTitle |
( |
| ) |
|
|
inline |
◆ GetTree()
◆ HasChildren()
bool HPS.HCA.ModelTreeItem.HasChildren |
( |
| ) |
|
|
inline |
◆ 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()
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 |
◆ IsHidden()
bool HPS.HCA.ModelTreeItem.IsHidden |
( |
| ) |
|
|
inline |
◆ IsHighlighted()
bool HPS.HCA.ModelTreeItem.IsHighlighted |
( |
| ) |
|
|
inline |
◆ 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