Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
HPS.ComponentTree Class Reference

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. More...

Inheritance diagram for HPS.ComponentTree:
HPS.Sprocket HPS.Object

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...
 
- Public Types inherited from HPS.Sprocket
enum  UpdateType { Synchronous = 0, Asynchronous = 1 }
 The type of update to perform, either synchronous or asynchronous. More...
 

Public Member Functions

override void Dispose ()
 
 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...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
virtual void Assign (HPS.ComponentTree in_that)
 Share the underlying smart-pointer of the ComponentTree source. More...
 
override bool Equals (System.Object obj)
 
override int GetHashCode ()
 
bool Equals (HPS.ComponentTree in_that)
 Check if the source ComponentTree points to the same underlying impl as this ComponentTree. 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. More...
 
HPS.HighlightOptionsKit GetHighlightOptions ()
 Gets the highlight options that will be used by this ComponentTree. 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...
 
HPS.ComponentTreeItem GetRoot ()
 Gets the root ComponentTreeItem for 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...
 
delegate HPS.Type ComponentTreeDelegate_0 ()
 
delegate void ComponentTreeDelegate_1 (IntPtr in_that)
 
delegate void ComponentTreeDelegate_2 ()
 
delegate bool ComponentTreeDelegate_3 ()
 
delegate void ComponentTreeDelegate_4 ()
 
delegate void DtorDelegate (IntPtr cPtr)
 
- Public Member Functions inherited from HPS.Sprocket
override void Dispose ()
 
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
 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...
 
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...
 
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More...
 

Static Public Member Functions

static bool operator== (HPS.ComponentTree a, HPS.ComponentTree b)
 
static bool operator!= (HPS.ComponentTree a, HPS.ComponentTree b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

void DtorCallback (IntPtr p)
 
override void deleteCptr ()
 
override IntPtr GetNonDirectorClassID ()
 
- Protected Member Functions inherited from HPS.Sprocket
override void deleteCptr ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
HandleRef cptr
 
HandleRef scptr
 
bool cMemOwn
 

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

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

HPS.ComponentTree.ComponentTree ( )
inline

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 
)
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_canvasThe <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_layerThe 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)
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_canvasThe <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)
inline

The copy constructor creates a ComponentTree object that shares the underlying smart-pointer of the source ComponentTree.

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_component_tree" kindref="compound">ComponentTree</ref> to copy.

Member Function Documentation

virtual void HPS.ComponentTree.Assign ( HPS.ComponentTree  in_that)
inlinevirtual

Share the underlying smart-pointer of the ComponentTree source.

Parameters
in_thatThe <ref refid="class_h_p_s_1_1_component_tree" kindref="compound">ComponentTree</ref> source of the assignment.
Returns
A reference to this ComponentTree.
bool HPS.ComponentTree.Equals ( HPS.ComponentTree  in_that)
inline

Check if the source ComponentTree points to the same underlying impl as this ComponentTree.

Parameters
in_thatThe 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>.
Returns
true if the objects reference the same impl, false otherwise.
virtual void HPS.ComponentTree.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.

HPS.HighlightOptionsKit HPS.ComponentTree.GetHighlightOptions ( )
inline

Gets the highlight options that will be used by this ComponentTree.

Returns
The highlight options that will be used by this ComponentTree.
HPS.ComponentTreeItem HPS.ComponentTree.GetRoot ( )
inline

Gets the root ComponentTreeItem for this ComponentTree.

Returns
The root ComponentTreeItem for this ComponentTree.
override HPS.Type HPS.ComponentTree.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Object.

void HPS.ComponentTree.SetHighlightOptions ( HPS.HighlightOptionsKit  in_options)
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.

Parameters
in_optionsThe highlight options that will be used by this <ref refid="class_h_p_s_1_1_component_tree" kindref="compound">ComponentTree</ref>.

ComponentTreeItem::Highlight

ComponentTreeItem::Unhighlight

ComponentPath::Highlight

ComponentPath::Unhighlight

void HPS.ComponentTree.SetRoot ( HPS.ComponentTreeItem  in_root)
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_rootThe 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

ComponentTreeItem::Expand


The documentation for this class was generated from the following file: