Inheritance diagram for HPS.BoundingKit:
HPS.Kit HPS.Object

Public Member Functions

 BoundingKit ()
 
 BoundingKit (HPS.BoundingKit in_kit)
 
override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.BoundingKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.BoundingKit in_kit)
 
HPS.BoundingKit SetExclusion (bool in_exclude)
 
HPS.BoundingKit SetVolume (HPS.SimpleSphere in_sphere)
 
HPS.BoundingKit SetVolume (HPS.SimpleCuboid in_cuboid)
 
void Show (out HPS.BoundingKit out_kit)
 
bool ShowExclusion (out bool out_exclusion)
 
bool ShowVolume (out HPS.SimpleSphere out_sphere, out HPS.SimpleCuboid out_cuboid)
 
HPS.BoundingKit UnsetEverything ()
 
HPS.BoundingKit UnsetExclusion ()
 
HPS.BoundingKit UnsetVolume ()
 
- Public Member Functions inherited from HPS.Kit
override void Dispose ()
 
 Kit (HPS.Kit in_that)
 
override HPS.Type ObjectType ()
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static HPS.BoundingKit GetDefault ()
 
static bool operator!= (HPS.BoundingKit a, HPS.BoundingKit b)
 
static bool operator== (HPS.BoundingKit a, HPS.BoundingKit 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.Kit
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
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

◆ BoundingKit() [1/2]

HPS.BoundingKit.BoundingKit ( )
inline

Initializes an empty kit.

◆ BoundingKit() [2/2]

HPS.BoundingKit.BoundingKit ( HPS.BoundingKit  in_kit)
inline

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

Parameters
in_kitThe source object to copy.

Member Function Documentation

◆ Empty()

override bool HPS.BoundingKit.Empty ( )
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.

◆ Equals()

bool HPS.BoundingKit.Equals ( HPS.BoundingKit  in_kit)
inline

Check if the source BoundingKit is equivalent to this object.

Parameters
in_kitThe source BoundingKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static HPS.BoundingKit HPS.BoundingKit.GetDefault ( )
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.

◆ ObjectType()

override HPS.Type HPS.BoundingKit.ObjectType ( )
inlinevirtual

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).

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

Reimplemented from HPS.Object.

◆ Set()

void HPS.BoundingKit.Set ( HPS.BoundingKit  in_kit)
inline

Copies all settings from the source BoundingKit into this object.

Parameters
in_kitThe source BoundingKit to copy.

◆ SetExclusion()

HPS.BoundingKit HPS.BoundingKit.SetExclusion ( bool  in_exclude)
inline

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

Parameters
in_excludeWhether to exclude this segment when computing bounding volumes.
Returns
A reference to this object.

◆ SetVolume() [1/2]

HPS.BoundingKit HPS.BoundingKit.SetVolume ( HPS.SimpleSphere  in_sphere)
inline

Explicitly sets the local bounding.

Parameters
in_sphereThe SimpleSphere to set the bounding volume to.
Returns
A reference to this object.

◆ SetVolume() [2/2]

HPS.BoundingKit HPS.BoundingKit.SetVolume ( HPS.SimpleCuboid  in_cuboid)
inline

Explicitly sets the local bounding.

Parameters
in_cuboidThe SimpleCuboid to set the bounding volume to.
Returns
A reference to this object.

◆ Show()

void HPS.BoundingKit.Show ( out HPS.BoundingKit  out_kit)
inline

Copies all settings from this BoundingKit into the given BoundingKit.

Parameters
out_kitThe BoundingKit to populate with the contents of this object.

◆ ShowExclusion()

bool HPS.BoundingKit.ShowExclusion ( out bool  out_exclusion)
inline

Shows the bounding exclusion setting.

Parameters
out_exclusionWhether to exclude this segment when computing bounding volumes.
Returns
true if the setting is valid, false otherwise.

◆ ShowVolume()

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

Shows the bounding volume.

Parameters
out_sphereA sphere to show the volume into. If the bounding is not a sphere, this argument will be invalidated.
out_cuboidA 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.

◆ UnsetEverything()

HPS.BoundingKit HPS.BoundingKit.UnsetEverything ( )
inline

Removes all bounding settings from this object.

Returns
A reference to this object.

◆ UnsetExclusion()

HPS.BoundingKit HPS.BoundingKit.UnsetExclusion ( )
inline

Removes a bounding exclusion setting.

Returns
A reference to this object.

◆ UnsetVolume()

HPS.BoundingKit HPS.BoundingKit.UnsetVolume ( )
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