
Public Types | |
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 } |
Enumerates the types of items that can be contained in a ComponentTree. More... | |
Public Member Functions | |
void | AddHighlightOptions (HPS.HighlightOptionsKit in_options) |
Appends one highlight options kit to the array that will be used by this ComponentTree. <linebreak> These options are used to perform highlights of elements within the tree and to determine what items within the tree need to be marked as highlighted when highlights are performed by ComponentPath.Highlight. If the options kit requested is already part of the ComponentTree highlight options array, it will not be added to it. More... | |
virtual void | Assign (HPS.ComponentTree in_that) |
Share the underlying smart-pointer of the ComponentTree source. More... | |
ComponentTree () | |
The default constructor creates an uninitialized ComponentTree object. The Type() function will return Type.None. More... | |
ComponentTree (HPS.Canvas in_canvas, ulong in_layer) | |
This constructor creates a ComponentTree object associated with a Canvas and a layer. This constructor should be used to create a new ComponentTree object. More... | |
ComponentTree (HPS.Canvas in_canvas) | |
This constructor creates a ComponentTree object associated with a Canvas and a layer. This constructor should be used to create a new ComponentTree object. More... | |
ComponentTree (HPS.ComponentTree in_that) | |
The copy constructor creates a ComponentTree object that shares the underlying smart-pointer of the source ComponentTree. More... | |
delegate HPS.Type | ComponentTreeDelegate_0 (IntPtr cPtr) |
delegate void | ComponentTreeDelegate_1 (IntPtr cPtr, IntPtr in_that) |
delegate void | ComponentTreeDelegate_2 (IntPtr cPtr) |
delegate HPS.Type | ComponentTreeDelegate_3 (IntPtr cPtr) |
delegate bool | ComponentTreeDelegate_4 (IntPtr cPtr) |
delegate void | ComponentTreeDelegate_5 (IntPtr cPtr) |
override void | Dispose () |
delegate void | DtorDelegate (IntPtr cPtr) |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.ComponentTree in_that) |
Check if the source ComponentTree points to the same underlying impl as this ComponentTree. More... | |
virtual void | Flush () |
Resets the root ComponentTreeItem for this ComponentTree. This will release the root ComponentTreeItem by this ComponentTree and set the root to a null pointer. If this function is overridden, the overriding function should invoke this base function. More... | |
override int | GetHashCode () |
bool | GetHighlightEventHandling () |
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. More... | |
HPS.HighlightOptionsKit [] | GetHighlightOptions () |
Gets the highlight options that will be used by this ComponentTree. More... | |
HPS.ComponentTreeItem | GetRoot () |
Gets the root ComponentTreeItem for this ComponentTree. More... | |
override HPS.Type | ObjectType () |
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). More... | |
void | ReExpand () |
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. More... | |
delegate void | RemoveCacheItemDelegate (IntPtr cPtr) |
void | SetHighlightEventHandling (bool in_state) |
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. More... | |
void | SetHighlightOptions (HPS.HighlightOptionsKit in_options) |
Sets the highlight options that will be used by this ComponentTree. These options are used to perform highlights of elements within the tree and to determine what items within the tree need to be marked as highlighted when highlights are performed by ComponentPath.Highlight. Calling this function replaces any highlight options previously set on this object. More... | |
void | SetHighlightOptions (HPS.HighlightOptionsKit[] in_options) |
Sets the highlight options that will be used by this ComponentTree. These options are used to perform highlights of elements within the tree and to determine what items within the tree need to be marked as highlighted when highlights are performed by ComponentPath.Highlight. Calling this function replaces any highlight options previously set on this object. All elements of the array should be unique. In the case of multiple identical elements, only the first unique one will be added. More... | |
void | SetRoot (HPS.ComponentTreeItem in_root) |
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. More... | |
![]() | |
override void | Dispose () |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
virtual HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
Static Public Member Functions | |
static bool | operator!= (HPS.ComponentTree a, HPS.ComponentTree b) |
static bool | operator== (HPS.ComponentTree a, HPS.ComponentTree b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
virtual bool | DerivedClassHasMethod (string methodName, System.Type[] methodTypes) |
override IntPtr | GetNonDirectorClassID () |
virtual bool | IsUserDerived () |
![]() | |
override void | deleteCptr () |
Protected Attributes | |
HandleRef | sptr |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Static Protected Attributes | |
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) |
Detailed Description
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.
Member Enumeration Documentation
◆ ItemType
|
strong |
Enumerates the types of items that can be contained in a ComponentTree.
Enumerator | |
---|---|
None | No type. |
ExchangeComponent | Item is an Exchange.Component. |
ExchangeModelFile | Item is an Exchange.CADModel. |
ExchangeViewGroup | Item is a collection of Exchange.Capture objects. |
ExchangeAnnotationViewGroup | Item is a collection of Exchange.Capture objects which are annotation captures. |
ExchangePMIGroup | Item is a collection of Exchange.Component objects representing PMI. |
ExchangeModelGroup | Item is a collection of root Exchange.Component objects. |
Constructor & Destructor Documentation
◆ ComponentTree() [1/4]
|
inline |
The default constructor creates an uninitialized ComponentTree object. The Type() function will return Type.None.
◆ ComponentTree() [2/4]
|
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
-
in_canvas The Canvas to associate this ComponentTree with. in_layer The layer in the Canvas to associate this ComponentTree with.
◆ ComponentTree() [3/4]
|
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
-
in_canvas The Canvas to associate this ComponentTree with.
◆ ComponentTree() [4/4]
|
inline |
The copy constructor creates a ComponentTree object that shares the underlying smart-pointer of the source ComponentTree.
- Parameters
-
in_that The source ComponentTree to copy.
Member Function Documentation
◆ AddHighlightOptions()
|
inline |
Appends one highlight options kit to the array that will be used by this ComponentTree. <linebreak> These options are used to perform highlights of elements within the tree and to determine what items within the tree need to be marked as highlighted when highlights are performed by ComponentPath.Highlight. If the options kit requested is already part of the ComponentTree highlight options array, it will not be added to it.
- Parameters
-
in_options The highlight options that will be used by this ComponentTree.
◆ Assign()
|
inlinevirtual |
Share the underlying smart-pointer of the ComponentTree source.
- Parameters
-
in_that The ComponentTree source of the assignment.
- Returns
- A reference to this ComponentTree.
◆ Equals()
|
inline |
Check if the source ComponentTree points to the same underlying impl as this ComponentTree.
- Parameters
-
in_that The source ComponentTree to compare to this ComponentTree.
- Returns
- true if the objects reference the same impl, false otherwise.
◆ Flush()
|
inlinevirtual |
Resets the root ComponentTreeItem for this ComponentTree. This will release the root ComponentTreeItem by this ComponentTree and set the root to a null pointer. If this function is overridden, the overriding function should invoke this base function.
◆ 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()
|
inline |
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()
|
inline |
Gets the root ComponentTreeItem for this ComponentTree.
- Returns
- The root ComponentTreeItem for this 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()
|
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()
|
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]
|
inline |
Sets the highlight options that will be used by this ComponentTree. These options are used to perform highlights of elements within the tree and to determine what items within the tree need to be marked as highlighted when highlights are performed by ComponentPath.Highlight. Calling this function replaces any highlight options previously set on this object.
- Parameters
-
in_options The highlight options that will be used by this ComponentTree.
◆ SetHighlightOptions() [2/2]
|
inline |
Sets the highlight options that will be used by this ComponentTree. These options are used to perform highlights of elements within the tree and to determine what items within the tree need to be marked as highlighted when highlights are performed by ComponentPath.Highlight. Calling this function replaces any highlight options previously set on this object. All elements of the array should be unique. In the case of multiple identical elements, only the first unique one will be added.
- Parameters
-
in_options An array of highlight options that will be used by this ComponentTree.
◆ SetRoot()
|
inline |
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
-
in_root The root ComponentTreeItem for this ComponentTree.
Flush
The documentation for this class was generated from the following file:
- internals/hps_sprk/source/cs/HPS.ComponentTree.cs