|
enum | ItemType {
ItemType.None = 0,
ItemType.ExchangeComponent = 1,
ItemType.ExchangeModelFile = 2,
ItemType.ExchangeViewGroup = 3,
ItemType.ExchangeAnnotationViewGroup = 4,
ItemType.ExchangePMIGroup = 5,
ItemType.ExchangeModelGroup = 6,
ParasolidComponent = 7,
ParasolidModelFile = 8,
DWGComponent = 9,
DWGModelFile = 10
} |
|
|
override void | deleteCptr () |
|
virtual bool | DerivedClassHasMethod (string methodName, System.Type[] methodTypes) |
|
override IntPtr | GetNonDirectorClassID () |
|
virtual bool | IsUserDerived () |
|
override void | deleteCptr () |
|
|
HandleRef | sptr |
|
bool | cMemOwn |
|
HandleRef | cptr |
|
|
static Dictionary< IntPtr, ComponentTree > | cachedObjects = new Dictionary<IntPtr, ComponentTree>() |
|
static Dictionary< IntPtr, WeakReference > | cachedWeakRefs = new Dictionary<IntPtr, WeakReference>() |
|
static ReaderWriterLockSlim | mapLock = new ReaderWriterLockSlim(LockRecursionPolicy.SupportsRecursion) |
|
The ComponentTree class is a smart pointer which corresponds to a tree object in a GUI toolkit, e.g., a TreeView in WPF or a CTreeCtrl in MFC. This class can be derived from to facilitate tree creation in the various GUI toolkits. It is used to create a component or model browser.
◆ ItemType
Enumerates the types of items that can be contained in a ComponentTree.
◆ ComponentTree() [1/4]
HPS.ComponentTree.ComponentTree |
( |
| ) |
|
|
inline |
The default constructor creates an uninitialized ComponentTree object. The Type() function will return Type.None.
◆ ComponentTree() [2/4]
HPS.ComponentTree.ComponentTree |
( |
HPS.Canvas |
in_canvas, |
|
|
ulong |
in_layer |
|
) |
| |
|
inline |
This constructor creates a ComponentTree object associated with a Canvas and a layer. This constructor should be used to create a new ComponentTree object.
- Parameters
-
◆ ComponentTree() [3/4]
HPS.ComponentTree.ComponentTree |
( |
HPS.Canvas |
in_canvas | ) |
|
|
inline |
This constructor creates a ComponentTree object associated with a Canvas and a layer. This constructor should be used to create a new ComponentTree object.
- Parameters
-
◆ ComponentTree() [4/4]
The copy constructor creates a ComponentTree object that shares the underlying smart-pointer of the source ComponentTree.
- Parameters
-
◆ AddHighlightOptions()
◆ Assign()
◆ Equals()
Check if the source ComponentTree points to the same underlying impl as this ComponentTree.
- Parameters
-
- Returns
- true if the objects reference the same impl, false otherwise.
◆ Flush()
virtual void HPS.ComponentTree.Flush |
( |
| ) |
|
|
inlinevirtual |
◆ GetHighlightEventHandling()
bool HPS.ComponentTree.GetHighlightEventHandling |
( |
| ) |
|
|
inline |
Whether this ComponentTree is currently handling highlight events This include expanding the tree to the highlighted components, and making the text for the highlighted component tree items bold.
- Returns
- Whether this ComponentTree is currently handling highlight events.
◆ GetHighlightOptions()
Gets the highlight options that will be used by this ComponentTree.
- Returns
- An array of highlight options that will be used by this ComponentTree.
◆ GetRoot()
◆ ObjectType()
override HPS.Type HPS.ComponentTree.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.ComponentTree.ReExpand |
( |
| ) |
|
|
inline |
Collapses the root ComponentTreeItem for this ComponentTree and then re-expands the tree. It will try to preserve the original expansion state, however, if the underlying component structure has changed, the resulting expansion may look different.
◆ SetHighlightEventHandling()
void HPS.ComponentTree.SetHighlightEventHandling |
( |
bool |
in_state | ) |
|
|
inline |
Whether the ComponentTree should handle highlighting events. This include expanding the tree to the highlighted components, and making the text for the highlighted component tree items bold. By default the ComponentTree will handle highlight events.
- Parameters
-
in_state | Whether to handle highlight events. |
◆ SetHighlightOptions() [1/2]
◆ SetHighlightOptions() [2/2]
◆ SetRoot()
Sets the root ComponentTreeItem for this ComponentTree. This object should be created on the heap and it should have been created with a ComponentTreeItem constructor which took a CADModel, otherwise an exception will be thrown. Additionally, if there was already an existing root for this ComponentTree, the Flush function will be invoked prior to setting this as the new root, and Expand will be invoked on the new root.
- Parameters
-
Flush
ComponentTreeItem.Expand
The documentation for this class was generated from the following file:
- internals/hps_sprk/source/cs/HPS.ComponentTree.cs