BoundingKit

class HPS.BoundingKit : public HPS.Kit

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.

Public Functions

BoundingKit ()

Initializes an empty kit.

BoundingKit (HPS.BoundingKit in_kit)

The copy constructor creates a new BoundingKit object that contains the same settings as the source object.

Param in_kit

The source object to copy.

override void Dispose ()

override bool Empty ()

Indicates whether this object has any values set on it.

Return

true if no values are set on this object, false otherwise.

bool Equals (HPS.BoundingKit in_kit)

Check if the source BoundingKit is equivalent to this object.

Param in_kit

The source BoundingKit to compare to this object.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

override HPS.Type ObjectType ()

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Return

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

void Set (HPS.BoundingKit in_kit)

Copies all settings from the source BoundingKit into this object.

Param in_kit

The source BoundingKit to copy.

HPS.BoundingKit SetExclusion (bool in_exclude)

Controls whether this segment should be excluded when computing bounding volumes.

Param in_exclude

Whether to exclude this segment when computing bounding volumes.

Return

A reference to this object.

HPS.BoundingKit SetVolume (HPS.SimpleCuboid in_cuboid)

Explicitly sets the local bounding.

Param in_cuboid

The SimpleCuboid to set the bounding volume to.

Return

A reference to this object.

HPS.BoundingKit SetVolume (HPS.SimpleSphere in_sphere)

Explicitly sets the local bounding.

Param in_sphere

The SimpleSphere to set the bounding volume to.

Return

A reference to this object.

void Show (out HPS.BoundingKit out_kit)

Copies all settings from this BoundingKit into the given BoundingKit.

Param out_kit

The BoundingKit to populate with the contents of this object.

bool ShowExclusion (out bool out_exclusion)

Shows the bounding exclusion setting.

Param out_exclusion

Whether to exclude this segment when computing bounding volumes.

Return

true if the setting is valid, false otherwise.

bool ShowVolume (out HPS.SimpleSphere out_sphere, out HPS.SimpleCuboid out_cuboid)

Shows the bounding volume.

Param out_sphere

A sphere to show the volume into. If the bounding is not a sphere, this argument will be invalidated.

Param out_cuboid

A cuboid to show the volume into. If the bounding is not a cuboid, this argument will be invalidated.

Return

true if the setting is valid, false otherwise.

HPS.BoundingKit UnsetEverything ()

Removes all bounding settings from this object.

Return

A reference to this object.

HPS.BoundingKit UnsetExclusion ()

Removes a bounding exclusion setting.

Return

A reference to this object.

HPS.BoundingKit UnsetVolume ()

Removes an explicitly set bounding, reverting to the automatically generated one.

Return

A reference to this object.

Public Static Functions

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.

Return

A BoundingKit with the default settings.

bool operator!= (HPS.BoundingKit a, HPS.BoundingKit b)

bool operator== (HPS.BoundingKit a, HPS.BoundingKit b)