Inheritance diagram for HPS.BoundingControl:
HPS.Control HPS.Object

Public Member Functions

 BoundingControl (HPS.SegmentKey in_seg)
 
 BoundingControl (HPS.BoundingControl in_that)
 
override void Dispose ()
 
override HPS.Type ObjectType ()
 
HPS.BoundingControl SetExclusion (bool in_exclusion)
 
HPS.BoundingControl SetVolume (HPS.SimpleSphere in_sphere, HPS.SimpleCuboid in_cuboid)
 
HPS.BoundingControl SetVolume (HPS.SimpleSphere in_sphere)
 
HPS.BoundingControl SetVolume (HPS.SimpleCuboid in_cuboid)
 
bool ShowExclusion (out bool out_exclusion)
 
bool ShowVolume (out HPS.SimpleSphere out_sphere, out HPS.SimpleCuboid out_cuboid)
 
override HPS.Type Type ()
 
HPS.BoundingControl UnsetEverything ()
 
HPS.BoundingControl UnsetExclusion ()
 
HPS.BoundingControl UnsetVolume ()
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
override void Dispose ()
 
override HPS.Type ObjectType ()
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Control
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The HPS.BoundingControl class is a smart pointer that is tied to a database object. This object allows you to manipulate settings related to bounding, such as volume and exclusion. This table lists default values for the various segment attributes accessible from HPS.BoundingControl.

Constructor & Destructor Documentation

◆ BoundingControl() [1/2]

HPS.BoundingControl.BoundingControl ( HPS.SegmentKey  in_seg)
inline

Initializes a control tied to the segment in_seg.

◆ BoundingControl() [2/2]

HPS.BoundingControl.BoundingControl ( HPS.BoundingControl  in_that)
inline

Initializes a control tied to the same object as in_that.

Member Function Documentation

◆ ObjectType()

override HPS.Type HPS.BoundingControl.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.

◆ SetExclusion()

HPS.BoundingControl HPS.BoundingControl.SetExclusion ( bool  in_exclusion)
inline

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

Returns
A reference to this object.

◆ SetVolume() [1/3]

HPS.BoundingControl HPS.BoundingControl.SetVolume ( HPS.SimpleSphere  in_sphere,
HPS.SimpleCuboid  in_cuboid 
)
inline

Explicitly sets the local bounding.

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

◆ SetVolume() [2/3]

HPS.BoundingControl HPS.BoundingControl.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() [3/3]

HPS.BoundingControl HPS.BoundingControl.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.

◆ ShowExclusion()

bool HPS.BoundingControl.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.BoundingControl.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.

◆ Type()

override HPS.Type HPS.BoundingControl.Type ( )
inlinevirtual

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.

Warning
This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
Returns
The true type of the object in question.

Reimplemented from HPS.Object.

◆ UnsetEverything()

HPS.BoundingControl HPS.BoundingControl.UnsetEverything ( )
inline

Removes all bounding settings from this object. If the control is attached to a WindowKey this function restores the default settings of this control as specified by BoundingKit.GetDefault().

Returns
A reference to this object.

◆ UnsetExclusion()

HPS.BoundingControl HPS.BoundingControl.UnsetExclusion ( )
inline

Removes a bounding exclusion setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by BoundingKit.GetDefault().

Returns
A reference to this object.

◆ UnsetVolume()

HPS.BoundingControl HPS.BoundingControl.UnsetVolume ( )
inline

Removes an explicitly set bounding, reverting to the automatically generated one. If the control is attached to a WindowKey this function restores the default value of this setting as specified by BoundingKit.GetDefault().

Returns
A reference to this object.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.BoundingControl.cs