REFERENCE MANUAL
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. More...
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 } |
Enumerates the types of items that can be contained in a ComponentTree. More... | |
![]() | |
enum | UpdateType { Synchronous = 0, Asynchronous = 1 } |
Public Member Functions | |
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. More... | |
ComponentTree (HPS.Canvas in_canvas, ulong in_layer) | |
This constructor creates a ComponentTree object associated with a Canvas and a layer. More... | |
ComponentTree (HPS.Canvas in_canvas) | |
This constructor creates a ComponentTree object associated with a Canvas and a layer. 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 () |
delegate void | ComponentTreeDelegate_1 (IntPtr in_that) |
delegate void | ComponentTreeDelegate_2 () |
delegate bool | ComponentTreeDelegate_3 () |
delegate void | ComponentTreeDelegate_4 () |
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. More... | |
override int | GetHashCode () |
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. More... | |
void | SetHighlightOptions (HPS.HighlightOptionsKit in_options) |
Sets the highlight options that will be used by this ComponentTree. More... | |
void | SetRoot (HPS.ComponentTreeItem in_root) |
Sets the root ComponentTreeItem for this ComponentTree. 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 an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. 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 () |
void | DtorCallback (IntPtr p) |
override IntPtr | GetNonDirectorClassID () |
![]() | |
override void | deleteCptr () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
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.
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. |
HPS.ComponentTree.ComponentTree | ( | ) |
The default constructor creates an uninitialized ComponentTree object.
The Type() function will return Type::None.
HPS.ComponentTree.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.
in_canvas | The <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> to associate this <ref refid="class_h_p_s_1_1_component_tree" kindref="compound">ComponentTree</ref> with. |
in_layer | The layer in the <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> to associate this <ref refid="class_h_p_s_1_1_component_tree" kindref="compound">ComponentTree</ref> with. |
HPS.ComponentTree.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.
in_canvas | The <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> to associate this <ref refid="class_h_p_s_1_1_component_tree" kindref="compound">ComponentTree</ref> with. |
HPS.ComponentTree.ComponentTree | ( | HPS.ComponentTree | in_that | ) |
The copy constructor creates a ComponentTree object that shares the underlying smart-pointer of the source ComponentTree.
in_that | The source <ref refid="class_h_p_s_1_1_component_tree" kindref="compound">ComponentTree</ref> to copy. |
|
virtual |
Share the underlying smart-pointer of the ComponentTree source.
in_that | The <ref refid="class_h_p_s_1_1_component_tree" kindref="compound">ComponentTree</ref> source of the assignment. |
bool HPS.ComponentTree.Equals | ( | HPS.ComponentTree | in_that | ) |
Check if the source ComponentTree points to the same underlying impl as this ComponentTree.
in_that | The source <ref refid="class_h_p_s_1_1_component_tree" kindref="compound">ComponentTree</ref> to compare to this <ref refid="class_h_p_s_1_1_component_tree" kindref="compound">ComponentTree</ref>. |
|
virtual |
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.
HPS.HighlightOptionsKit HPS.ComponentTree.GetHighlightOptions | ( | ) |
Gets the highlight options that will be used by this ComponentTree.
HPS.ComponentTreeItem HPS.ComponentTree.GetRoot | ( | ) |
Gets the root ComponentTreeItem for this ComponentTree.
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
void HPS.ComponentTree.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.
in_options | The highlight options that will be used by this <ref refid="class_h_p_s_1_1_component_tree" kindref="compound">ComponentTree</ref>. |
void HPS.ComponentTree.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.
in_root | The root <ref refid="class_h_p_s_1_1_component_tree_item" kindref="compound">ComponentTreeItem</ref> for this <ref refid="class_h_p_s_1_1_component_tree" kindref="compound">ComponentTree</ref>. |
Flush