The BoundingKit class is a user space object, useful for carrying a group of attribute settings.
More...
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
HandleRef | scptr |
|
The BoundingKit class is a user space object, useful for carrying a group of attribute settings.
Calling BoundingKit::GetDefault() will return a kit with values found in this table.
HPS.BoundingKit.BoundingKit |
( |
| ) |
|
Initializes an empty kit.
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. |
override bool HPS.BoundingKit.Empty |
( |
| ) |
|
|
virtual |
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.
Check if the source BoundingKit is equivalent to this object.
- Parameters
-
in_kit | The source <ref refid="class_h_p_s_1_1_bounding_kit" kindref="compound">BoundingKit</ref> to compare to this object. |
- Returns
- true if the objects are equivalent, false otherwise.
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.
override HPS.Type HPS.BoundingKit.ObjectType |
( |
| ) |
|
|
virtual |
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.
Copies all settings from the source BoundingKit into this object.
- Parameters
-
in_kit | The source <ref refid="class_h_p_s_1_1_bounding_kit" kindref="compound">BoundingKit</ref> to copy. |
Controls whether this segment should be excluded when computing bounding volumes.
- Returns
- A reference to this object.
Explicitly sets the local bounding.
- Parameters
-
- Returns
- A reference to this object.
Explicitly sets the local bounding.
- Parameters
-
- Returns
- A reference to this object.
Copies all settings from this BoundingKit into the given BoundingKit.
- Parameters
-
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. |
bool HPS.BoundingKit.ShowExclusion |
( |
out bool |
out_exclusion | ) |
|
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.
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.
Removes all bounding settings from this object.
- Returns
- A reference to this object.
Removes a bounding exclusion setting.
- Returns
- A reference to this object.
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: