|
class | SceneTreeItemUnknown |
|
|
abstract HPS.SceneTreeItem | AddChild (HPS.Key in_key, HPS.SceneTree.ItemType in_type, string in_title) |
|
abstract HPS.SceneTreeItem | AddChild (HPS.Key in_key, HPS.SceneTree.ItemType in_type) |
|
virtual void | Assign (HPS.SceneTreeItem in_that) |
|
virtual void | Collapse () |
|
override void | Dispose () |
|
delegate void | DtorDelegate (IntPtr cPtr) |
|
override bool | Equals (System.Object obj) |
|
bool | Equals (HPS.SceneTreeItem in_that) |
|
virtual void | Expand () |
|
override int | GetHashCode () |
|
HPS.SceneTree.ItemType | GetItemType () |
|
HPS.Key | GetKey () |
|
HPS.KeyPath | GetKeyPath () |
|
string | GetTitle () |
|
HPS.SceneTree | GetTree () |
|
bool | HasChildren () |
|
bool | HasItemType (HPS.SceneTree.ItemType in_mask) |
|
void | Highlight (ulong in_highlight_options_index) |
|
void | Highlight () |
|
void | Highlight (HPS.HighlightOptionsKit in_highlight_options) |
|
bool | IsExpanded () |
|
bool | IsHighlightable () |
|
bool | IsHighlighted () |
|
bool | IsSelected () |
|
override HPS.Type | ObjectType () |
|
void | ReExpand () |
|
delegate void | RemoveCacheItemDelegate (IntPtr cPtr) |
|
| SceneTreeItem () |
|
| SceneTreeItem (HPS.SceneTreeItem in_that) |
|
| SceneTreeItem (HPS.SceneTree in_tree, HPS.Model in_model) |
|
| SceneTreeItem (HPS.SceneTree in_tree, HPS.View in_view) |
|
| SceneTreeItem (HPS.SceneTree in_tree, HPS.Layout in_layout) |
|
| SceneTreeItem (HPS.SceneTree in_tree, HPS.Canvas in_canvas) |
|
| SceneTreeItem (HPS.SceneTree in_tree, HPS.Key in_key, HPS.SceneTree.ItemType in_type, string in_title) |
|
| SceneTreeItem (HPS.SceneTree in_tree, HPS.Key in_key, HPS.SceneTree.ItemType in_type) |
|
virtual void | Select () |
|
void | Unhighlight (ulong in_highlight_options_index) |
|
void | Unhighlight () |
|
void | Unhighlight (HPS.HighlightOptionsKit in_highlight_options) |
|
virtual void | Unselect () |
|
override void | Dispose () |
|
| Sprocket (HPS.Sprocket in_that) |
|
virtual bool | Empty () |
|
IntPtr | GetClassID () |
|
IntPtr | GetInstanceID () |
|
bool | HasType (HPS.Type in_mask) |
|
| Object (HPS.Object that) |
|
virtual void | Reset () |
|
virtual HPS.Type | Type () |
|
|
override void | deleteCptr () |
|
virtual bool | DerivedClassHasMethod (string methodName, System.Type[] methodTypes) |
|
virtual bool | IsUserDerived () |
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
HandleRef | sptr |
|
bool | cMemOwn |
|
HandleRef | cptr |
|
|
static Dictionary< IntPtr, SceneTreeItem > | cachedObjects = new Dictionary<IntPtr, SceneTreeItem>() |
|
static Dictionary< IntPtr, WeakReference > | cachedWeakRefs = new Dictionary<IntPtr, WeakReference>() |
|
static ReaderWriterLockSlim | mapLock = new ReaderWriterLockSlim(LockRecursionPolicy.SupportsRecursion) |
|
The SceneTreeItem 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 scene graph or segment browser.
◆ SceneTreeItem() [1/8]
HPS.SceneTreeItem.SceneTreeItem |
( |
| ) |
|
|
inline |
The default constructor creates an uninitialized SceneTreeItem object. The Type() function will return Type.None.
◆ SceneTreeItem() [2/8]
The copy constructor creates a SceneTreeItem object that shares the underlying smart-pointer of the source SceneTreeItem.
- Parameters
-
◆ SceneTreeItem() [3/8]
◆ SceneTreeItem() [4/8]
◆ SceneTreeItem() [5/8]
◆ SceneTreeItem() [6/8]
◆ SceneTreeItem() [7/8]
This constructor creates a SceneTreeItem which is not suitable for acting as a root in a SceneTree, but is suitable to be a SceneTreeItem under the root of the SceneTree. This constructor should be the one invoked in the overridden AddChild function.
- Parameters
-
in_tree | The SceneTree with which to associate this new SceneTreeItem. |
in_key | The Key for this SceneTreeItem. This value should come from the corresponding argument to AddChild. |
in_type | The type of this SceneTreeItem. This value should come from the corresponding argument to AddChild. |
in_title | The title for this SceneTreeItem. This value should come from the corresponding argument to AddChild. |
- See also
- AddChild
◆ SceneTreeItem() [8/8]
This constructor creates a SceneTreeItem which is not suitable for acting as a root in a SceneTree, but is suitable to be a SceneTreeItem under the root of the SceneTree. This constructor should be the one invoked in the overridden AddChild function.
- Parameters
-
in_tree | The SceneTree with which to associate this new SceneTreeItem. |
in_key | The Key for this SceneTreeItem. This value should come from the corresponding argument to AddChild. |
in_type | The type of this SceneTreeItem. This value should come from the corresponding argument to AddChild. |
- See also
- AddChild
◆ AddChild() [1/2]
This function is used to create a new SceneTreeItem to be the child of this SceneTreeItem. This function will be invoked if this SceneTreeItem 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, e.g., see the implementations in the mfc_sandbox or wpf_sandbox. Additionally, since this function requires the creation of a derived SceneTreeItem, that derived SceneTreeItem should use the base constructor which takes the same arguments this function.
- Parameters
-
in_key | The Key for this SceneTreeItem. Should be passed to as the corresponding argument to the base constructor. |
in_type | The type for this SceneTreeItem. Should be passed to as the corresponding argument to the base constructor. |
in_title | The title for this SceneTreeItem. Should be passed to as the corresponding argument to the base constructor. |
- Returns
- A newly created object derived from SceneTreeItem.
◆ AddChild() [2/2]
This function is used to create a new SceneTreeItem to be the child of this SceneTreeItem. This function will be invoked if this SceneTreeItem 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, e.g., see the implementations in the mfc_sandbox or wpf_sandbox. Additionally, since this function requires the creation of a derived SceneTreeItem, that derived SceneTreeItem should use the base constructor which takes the same arguments this function.
- Parameters
-
in_key | The Key for this SceneTreeItem. Should be passed to as the corresponding argument to the base constructor. |
in_type | The type for this SceneTreeItem. Should be passed to as the corresponding argument to the base constructor. |
- Returns
- A newly created object derived from SceneTreeItem.
◆ Assign()
◆ Collapse()
virtual void HPS.SceneTreeItem.Collapse |
( |
| ) |
|
|
inlinevirtual |
This function should be invoked when this SceneTreeItem 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 SceneTreeItem when invoked.
◆ Equals()
Check if the source SceneTreeItem points to the same underlying impl as this SceneTreeItem.
- Parameters
-
- Returns
- true if the objects reference the same impl, false otherwise.
◆ Expand()
virtual void HPS.SceneTreeItem.Expand |
( |
| ) |
|
|
inlinevirtual |
This function should be invoked when this SceneTreeItem 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 SceneTreeItem when invoked.
◆ GetItemType()
◆ GetKey()
HPS.Key HPS.SceneTreeItem.GetKey |
( |
| ) |
|
|
inline |
◆ GetKeyPath()
◆ GetTitle()
string HPS.SceneTreeItem.GetTitle |
( |
| ) |
|
|
inline |
◆ GetTree()
◆ HasChildren()
bool HPS.SceneTreeItem.HasChildren |
( |
| ) |
|
|
inline |
◆ HasItemType()
Indicates whether this SceneTreeItem has the given ItemType mask.
- Parameters
-
- Returns
- true if this SceneTreeItem has the given ItemType mask, false otherwise.
◆ Highlight() [1/3]
void HPS.SceneTreeItem.Highlight |
( |
ulong |
in_highlight_options_index | ) |
|
|
inline |
This function will cause this SceneTreeItem to be highlighted with the options specified in the associated SceneTree. This will cause elements along the path to this item (and this item itself) to be marked as selected if they aren't already. Depending on the type of the SceneTreeItem, sometimes a highlight is nonsensical. In this case, no highlight will be performed.
- See also
- Select
◆ Highlight() [2/3]
void HPS.SceneTreeItem.Highlight |
( |
| ) |
|
|
inline |
This function will cause this SceneTreeItem to be highlighted with the options specified in the associated SceneTree. This will cause elements along the path to this item (and this item itself) to be marked as selected if they aren't already. Depending on the type of the SceneTreeItem, sometimes a highlight is nonsensical. In this case, no highlight will be performed.
- See also
- Select
◆ Highlight() [3/3]
This function will cause this SceneTreeItem to be highlighted with the options specified in the associated SceneTree. This will cause elements along the path to this item (and this item itself) to be marked as selected if they aren't already. Depending on the type of the SceneTreeItem, sometimes a highlight is nonsensical. In this case, no highlight will be performed. If the options requested is not part of the associated SceneTree highlight options, it will be added to them.
- Parameters
-
in_highlight_options | The highlight options used during highlighting |
- See also
- Select
◆ IsExpanded()
bool HPS.SceneTreeItem.IsExpanded |
( |
| ) |
|
|
inline |
◆ IsHighlightable()
bool HPS.SceneTreeItem.IsHighlightable |
( |
| ) |
|
|
inline |
◆ IsHighlighted()
bool HPS.SceneTreeItem.IsHighlighted |
( |
| ) |
|
|
inline |
◆ IsSelected()
bool HPS.SceneTreeItem.IsSelected |
( |
| ) |
|
|
inline |
◆ ObjectType()
override HPS.Type HPS.SceneTreeItem.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.
◆ ReExpand()
void HPS.SceneTreeItem.ReExpand |
( |
| ) |
|
|
inline |
Collapses this SceneTreeItem and then re-expands the tree. It will try to preserve the original expansion state, however, if the underlying scene structure has changed, the resulting expansion may look different.
◆ Select()
virtual void HPS.SceneTreeItem.Select |
( |
| ) |
|
|
inlinevirtual |
This function will be invoked when this SceneTreeItem should be marked as selected. Marking an item as selected means that the key backing this SceneTreeItem has been highlighted with the options specified in the associated SceneTree or is along a path in which a highlight has occurred. This highlighting may have come as a result of the Highlight function on a SceneTreeItem being invoked (not necessarily this SceneTreeItem), or potentially due to the HighlightOperator or HighlightAreaOperator highlighting the key backing this SceneTreeItem or highlighting some path which includes the key backing this SceneTreeItem. This function is meant to be overridden to allow one to change the appearance of a selected SceneTreeItem, e.g., by bolding the text or changing an icon, to signify this new state. If this function is overridden, the overriding function should invoke this base function.
◆ Unhighlight() [1/3]
void HPS.SceneTreeItem.Unhighlight |
( |
ulong |
in_highlight_options_index | ) |
|
|
inline |
This function will remove the highlight with the options specified in the associated SceneTree from this SceneTreeItem. This can cause elements along the path to this item (and this item itself) to be marked as unselected unless those items lie along a path which is still highlighted. Depending on the type of the SceneTreeItem, sometimes an unhighlight is nonsensical. In this case, no unhighlight will be performed.
- See also
- Unselect
◆ Unhighlight() [2/3]
void HPS.SceneTreeItem.Unhighlight |
( |
| ) |
|
|
inline |
This function will remove the highlight with the options specified in the associated SceneTree from this SceneTreeItem. This can cause elements along the path to this item (and this item itself) to be marked as unselected unless those items lie along a path which is still highlighted. Depending on the type of the SceneTreeItem, sometimes an unhighlight is nonsensical. In this case, no unhighlight will be performed.
- See also
- Unselect
◆ Unhighlight() [3/3]
This function will remove the highlight with the options specified in the associated SceneTree from this SceneTreeItem. This can cause elements along the path to this item (and this item itself) to be marked as unselected unless those items lie along a path which is still highlighted. Depending on the type of the SceneTreeItem, sometimes an unhighlight is nonsensical. In this case, no unhighlight will be performed. If the options requested is not part of the associated SceneTree highlight options, it will be added to them.
- See also
- Unselect
◆ Unselect()
virtual void HPS.SceneTreeItem.Unselect |
( |
| ) |
|
|
inlinevirtual |
This function will be invoked when this SceneTreeItem should be marked as unselected. Marking an item as unselected means that the key backing this SceneTreeItem is no longer highlighted with the options specified in the associated SceneTree or is no longer along a path in which a highlight has occurred. This unhighlighting may have come as a result of the Unhighlight function on a SceneTreeItem being invoked (not necessarily this SceneTreeItem), or potentially due to the HighlightOperator or HighlightAreaOperator unhighlighting the key backing this SceneTreeItem. or unhighlighting some path which includes the key backing this SceneTreeItem. This function is meant to be overridden to allow one to change the appearance of a selected SceneTreeItem, e.g., by no longer bolding the text or changing an icon, to signify this new state. If this function is overridden, the overriding function should invoke this base function.
The documentation for this class was generated from the following file:
- internals/hps_sprk/source/cs/HPS.SceneTreeItem.cs