The HPS::BoundingKit class is a user space object, useful for carrying a group of attribute settings. Calling HPS::BoundingKit::GetDefault() will return a kit with values found in this table. More...
Public Member Functions | |
override void | Dispose () |
BoundingKit () | |
Initializes an empty kit. More... | |
BoundingKit (HPS.BoundingKit in_kit) | |
The copy constructor creates a new BoundingKit object that contains the same settings as the source 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... | |
void | Set (HPS.BoundingKit in_kit) |
Copies all settings from the source BoundingKit into this object. More... | |
void | Show (out HPS.BoundingKit out_kit) |
Copies all settings from this BoundingKit into the given BoundingKit. More... | |
override bool | Empty () |
Indicates whether this object has any values set on it. More... | |
override bool | Equals (System.Object obj) |
override int | GetHashCode () |
bool | Equals (HPS.BoundingKit in_kit) |
Check if the source BoundingKit is equivalent to this object. More... | |
HPS.BoundingKit | SetVolume (HPS.SimpleSphere in_sphere) |
Explicitly sets the local bounding. More... | |
HPS.BoundingKit | SetVolume (HPS.SimpleCuboid in_cuboid) |
Explicitly sets the local bounding. More... | |
HPS.BoundingKit | SetExclusion (bool in_exclude) |
Controls whether this segment should be excluded when computing bounding volumes. More... | |
HPS.BoundingKit | UnsetVolume () |
Removes an explicitly set bounding, reverting to the automatically generated one. More... | |
HPS.BoundingKit | UnsetExclusion () |
Removes a bounding exclusion setting. More... | |
HPS.BoundingKit | UnsetEverything () |
Removes all bounding settings from this object. More... | |
bool | ShowVolume (out HPS.SimpleSphere out_sphere, out HPS.SimpleCuboid out_cuboid) |
Shows the bounding volume. More... | |
bool | ShowExclusion (out bool out_exclusion) |
Shows the bounding exclusion setting. More... | |
![]() | |
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 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 HPS.BoundingKit | GetDefault () |
Creates a BoundingKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default. More... | |
static bool | operator== (HPS.BoundingKit a, HPS.BoundingKit b) |
static bool | operator!= (HPS.BoundingKit a, HPS.BoundingKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
HandleRef | cptr |
HandleRef | scptr |
bool | cMemOwn |
The HPS::BoundingKit class is a user space object, useful for carrying a group of attribute settings. Calling HPS::BoundingKit::GetDefault() will return a kit with values found in this table.
|
inline |
Initializes an empty kit.
|
inline |
The copy constructor creates a new BoundingKit object that contains the same settings as the source object.
in_kit | The source object to copy. |
|
inlinevirtual |
Indicates whether this object has any values set on it.
Reimplemented from HPS.Object.
|
inline |
Check if the source BoundingKit is equivalent to this object.
in_kit | The source <ref refid="class_h_p_s_1_1_bounding_kit" kindref="compound">BoundingKit</ref> to compare to this object. |
|
inlinestatic |
Creates a BoundingKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.
|
inlinevirtual |
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.
|
inline |
Copies all settings from the source BoundingKit into this object.
in_kit | The source <ref refid="class_h_p_s_1_1_bounding_kit" kindref="compound">BoundingKit</ref> to copy. |
|
inline |
Controls whether this segment should be excluded when computing bounding volumes.
in_exclude | Whether to exclude this segment when computing bounding volumes. |
|
inline |
Explicitly sets the local bounding.
in_sphere | The SimpleSphere to set the bounding volume to. |
|
inline |
Explicitly sets the local bounding.
in_cuboid | The SimpleCuboid to set the bounding volume to. |
|
inline |
Copies all settings from this BoundingKit into the given BoundingKit.
out_kit | The <ref refid="class_h_p_s_1_1_bounding_kit" kindref="compound">BoundingKit</ref> to populate with the contents of this object. |
|
inline |
Shows the bounding exclusion setting.
out_exclusion | Whether to exclude this segment when computing bounding volumes. |
|
inline |
Shows the bounding volume.
out_sphere | A sphere to show the volume into. If the bounding is not a sphere, this argument will be invalidated. |
out_cuboid | A cuboid to show the volume into. If the bounding is not a cuboid, this argument will be invalidated. |
|
inline |
Removes all bounding settings from this object.
|
inline |
Removes a bounding exclusion setting.
|
inline |
Removes an explicitly set bounding, reverting to the automatically generated one.