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

The TreeContext class is a user space object. It contains a spatial partition used for selection and relation computations with shells. If many world-space selections are going to be computed without modifying the segment tree, using the same tree context for all of them can be a significant optimization. If one is not specified, a new one is computed internally each time. More...

Inheritance diagram for HPS.TreeContext:
HPS.Object

Public Member Functions

override void Dispose ()
 
 TreeContext (bool in_create)
 The default constructor creates a new TreeContext object. More...
 
 TreeContext ()
 The default constructor creates a new TreeContext object. More...
 
 TreeContext (HPS.TreeContext in_that)
 The copy constructor shares a TreeContext object. 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...
 
override bool Equals (System.Object obj)
 
override int GetHashCode ()
 
bool Equals (HPS.TreeContext in_that)
 Check if the source TreeContext is the same as this TreeContext. More...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
 Object (HPS.Object that)
 
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.TreeContext a, HPS.TreeContext b)
 
static bool operator!= (HPS.TreeContext a, HPS.TreeContext b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

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

Detailed Description

The TreeContext class is a user space object. It contains a spatial partition used for selection and relation computations with shells. If many world-space selections are going to be computed without modifying the segment tree, using the same tree context for all of them can be a significant optimization. If one is not specified, a new one is computed internally each time.

Constructor & Destructor Documentation

HPS.TreeContext.TreeContext ( bool  in_create)
inline

The default constructor creates a new TreeContext object.

Parameters
in_createwhether to create the underlying spatial tree context.
HPS.TreeContext.TreeContext ( )
inline

The default constructor creates a new TreeContext object.

HPS.TreeContext.TreeContext ( HPS.TreeContext  in_that)
inline

The copy constructor shares a TreeContext object.

Parameters
in_thatThe source TreeContext to share.

Member Function Documentation

bool HPS.TreeContext.Equals ( HPS.TreeContext  in_that)
inline

Check if the source TreeContext is the same as this TreeContext.

Returns
true if the objects are identical, false otherwise.
override HPS.Type HPS.TreeContext.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.


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