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 | |
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 void | Dispose () |
override bool | Empty () |
Indicates whether this object has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.BoundingKit in_kit) |
Check if the source BoundingKit is equivalent to this object. More... | |
override int | GetHashCode () |
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... | |
HPS.BoundingKit | SetExclusion (bool in_exclude) |
Controls whether this segment should be excluded when computing bounding volumes. 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... | |
void | Show (out HPS.BoundingKit out_kit) |
Copies all settings from this BoundingKit into the given BoundingKit. More... | |
bool | ShowExclusion (out bool out_exclusion) |
Shows the bounding exclusion setting. More... | |
bool | ShowVolume (out HPS.SimpleSphere out_sphere, out HPS.SimpleCuboid out_cuboid) |
Shows the bounding volume. More... | |
HPS.BoundingKit | UnsetEverything () |
Removes all bounding settings from this object. More... | |
HPS.BoundingKit | UnsetExclusion () |
Removes a bounding exclusion setting. More... | |
HPS.BoundingKit | UnsetVolume () |
Removes an explicitly set bounding, reverting to the automatically generated one. More... | |
![]() | |
IntPtr | GetClassID () |
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... | |
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... | |
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 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 | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
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.
Constructor & Destructor Documentation
|
inline |
Initializes an empty kit.
|
inline |
The copy constructor creates a new BoundingKit object that contains the same settings as the source object.
- Parameters
-
in_kit The source object to copy.
Member Function Documentation
|
inlinevirtual |
Indicates whether this object has any values set on it.
- Returns
- true if no values are set on this object, false otherwise.
Reimplemented from HPS.Object.
|
inline |
Check if the source BoundingKit is equivalent to this object.
- Parameters
-
in_kit The source BoundingKit to compare to this object.
- Returns
- true if the objects are equivalent, false otherwise.
|
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.
- Returns
- A BoundingKit with the default settings.
|
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.
|
inline |
Copies all settings from the source BoundingKit into this object.
- Parameters
-
in_kit The source BoundingKit to copy.
|
inline |
Controls whether this segment should be excluded when computing bounding volumes.
- Parameters
-
in_exclude Whether to exclude this segment when computing bounding volumes.
- Returns
- A reference to this object.
|
inline |
Explicitly sets the local bounding.
- Parameters
-
in_sphere The SimpleSphere to set the bounding volume to.
- Returns
- A reference to this object.
|
inline |
Explicitly sets the local bounding.
- Parameters
-
in_cuboid The SimpleCuboid to set the bounding volume to.
- Returns
- A reference to this object.
|
inline |
Copies all settings from this BoundingKit into the given BoundingKit.
- Parameters
-
out_kit The BoundingKit to populate with the contents of this object.
|
inline |
Shows the bounding exclusion setting.
- Parameters
-
out_exclusion Whether to exclude this segment when computing bounding volumes.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the bounding volume.
- Parameters
-
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.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Removes all bounding settings from this object.
- Returns
- A reference to this object.
|
inline |
Removes a bounding exclusion setting.
- Returns
- A reference to this object.
|
inline |
Removes an explicitly set bounding, reverting to the automatically generated one.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.BoundingKit.cs