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

Public Member Functions

 CutGeometryGatheringOptionsKit ()
 
 CutGeometryGatheringOptionsKit (HPS.CutGeometryGatheringOptionsKit in_kit)
 
override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.CutGeometryGatheringOptionsKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.CutGeometryGatheringOptionsKit in_kit)
 
HPS.CutGeometryGatheringOptionsKit SetColor (bool in_color)
 
HPS.CutGeometryGatheringOptionsKit SetCuttingSection (HPS.CuttingSectionKey in_cutter)
 
HPS.CutGeometryGatheringOptionsKit SetLevel (HPS.CuttingSection.GatheringLevel in_level)
 
HPS.CutGeometryGatheringOptionsKit SetOffset (ulong in_offset)
 
void Show (out HPS.CutGeometryGatheringOptionsKit out_kit)
 
bool ShowColor (out bool out_color)
 
bool ShowCuttingSection (out HPS.CuttingSectionKey out_cutter)
 
bool ShowLevel (out HPS.CuttingSection.GatheringLevel out_level)
 
bool ShowOffset (out ulong out_offset)
 
HPS.CutGeometryGatheringOptionsKit UnsetColor ()
 
HPS.CutGeometryGatheringOptionsKit UnsetCuttingSection ()
 
HPS.CutGeometryGatheringOptionsKit UnsetEverything ()
 
HPS.CutGeometryGatheringOptionsKit UnsetLevel ()
 
HPS.CutGeometryGatheringOptionsKit UnsetOffset ()
 
- 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.CutGeometryGatheringOptionsKit GetDefault ()
 
static bool operator!= (HPS.CutGeometryGatheringOptionsKit a, HPS.CutGeometryGatheringOptionsKit b)
 
static bool operator== (HPS.CutGeometryGatheringOptionsKit a, HPS.CutGeometryGatheringOptionsKit 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
 

Constructor & Destructor Documentation

◆ CutGeometryGatheringOptionsKit() [1/2]

HPS.CutGeometryGatheringOptionsKit.CutGeometryGatheringOptionsKit ( )
inline

The default constructor creates an empty CutGeometryGatheringOptionsKit object.

◆ CutGeometryGatheringOptionsKit() [2/2]

HPS.CutGeometryGatheringOptionsKit.CutGeometryGatheringOptionsKit ( HPS.CutGeometryGatheringOptionsKit  in_kit)
inline

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

Parameters
in_kitThe source CutGeometryGatheringOptionsKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.CutGeometryGatheringOptionsKit.Empty ( )
inlinevirtual

Indicates whether this CutGeometryGatheringOptionsKit has any values set on it.

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

Reimplemented from HPS.Object.

◆ Equals()

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

Check if the source CutGeometryGatheringOptionsKit is equivalent to this CutGeometryGatheringOptionsKit.

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

◆ GetDefault()

static HPS.CutGeometryGatheringOptionsKit HPS.CutGeometryGatheringOptionsKit.GetDefault ( )
inlinestatic

Creates a CutGeometryGatheringOptionsKit 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 CutGeometryGatheringOptionsKit with the default settings.

◆ ObjectType()

override HPS.Type HPS.CutGeometryGatheringOptionsKit.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.CutGeometryGatheringOptionsKit.Set ( HPS.CutGeometryGatheringOptionsKit  in_kit)
inline

Copies the source CutGeometryGatheringOptionsKit into this CutGeometryGatheringOptionsKit.

Parameters
in_kitThe source CutGeometryGatheringOptionsKit to copy.

◆ SetColor()

HPS.CutGeometryGatheringOptionsKit HPS.CutGeometryGatheringOptionsKit.SetColor ( bool  in_color)
inline

Sets whether the implicit color is collected with the capping geometry.

Parameters
in_colorWhether the color is collected.
Returns
A reference to this CutGeometryGatheringOptionsKit.

◆ SetCuttingSection()

HPS.CutGeometryGatheringOptionsKit HPS.CutGeometryGatheringOptionsKit.SetCuttingSection ( HPS.CuttingSectionKey  in_cutter)
inline

Sets a single cutting section for which to collect capping geometry. If this is not specified, caps for all cutting sections will be collected.

Parameters
in_cutterA single cutting section that is interesting for capping geometry collection.
Returns
A reference to this CutGeometryGatheringOptionsKit.

◆ SetLevel()

HPS.CutGeometryGatheringOptionsKit HPS.CutGeometryGatheringOptionsKit.SetLevel ( HPS.CuttingSection.GatheringLevel  in_level)
inline

Sets the level at which to collect the capping geometry.

Parameters
in_levelWhether the capping geometry should be collected from just a single segment or an entire subtree.
Returns
A reference to this CutGeometryGatheringOptionsKit.

◆ SetOffset()

HPS.CutGeometryGatheringOptionsKit HPS.CutGeometryGatheringOptionsKit.SetOffset ( ulong  in_offset)
inline

If a single cutting section is specified, this sets the plane offset into that section. If this is not set, all planes in that section will be collected.

Parameters
in_offsetAn offset for a single plane in a cutting section.
Returns
A reference to this CutGeometryGatheringOptionsKit.

◆ Show()

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

Copies this CutGeometryGatheringOptionsKit into the given CutGeometryGatheringOptionsKit.

Parameters
out_kitThe CutGeometryGatheringOptionsKit to populate with the contents of this CutGeometryGatheringOptionsKit.

◆ ShowColor()

bool HPS.CutGeometryGatheringOptionsKit.ShowColor ( out bool  out_color)
inline

Shows the color gathering preference whe collecting capping geometry.

Parameters
out_colorWhether the implicit color of the capping geometry should be collected along with the geometry.
Returns
true if a color gathering preference was set, false otherwise.

◆ ShowCuttingSection()

bool HPS.CutGeometryGatheringOptionsKit.ShowCuttingSection ( out HPS.CuttingSectionKey  out_cutter)
inline

Shows a cutting section that is interesting for capping geometry collection.

Parameters
out_cutterA cutting section that is interesting for capping geometry collection.
Returns
true if a cutting section was set, false otherwise.

◆ ShowLevel()

bool HPS.CutGeometryGatheringOptionsKit.ShowLevel ( out HPS.CuttingSection.GatheringLevel  out_level)
inline

Shows the level at which to collect the capping geometry.

Parameters
out_levelWhether the capping geometry should be collected from just a single segment or an entire subtree.
Returns
true if a level was set, false otherwise.

◆ ShowOffset()

bool HPS.CutGeometryGatheringOptionsKit.ShowOffset ( out ulong  out_offset)
inline

Shows an offset for a single plane in a cutting section.

Parameters
out_offsetAn offset for a single plane in a cutting section.
Returns
true if an offset was set, false otherwise.

◆ UnsetColor()

HPS.CutGeometryGatheringOptionsKit HPS.CutGeometryGatheringOptionsKit.UnsetColor ( )
inline

Removes the color setting when collecting the capping geometry.

Returns
A reference to this CutGeometryGatheringOptionsKit.

◆ UnsetCuttingSection()

HPS.CutGeometryGatheringOptionsKit HPS.CutGeometryGatheringOptionsKit.UnsetCuttingSection ( )
inline

Removes a single cutting section for which to collect capping geometry.

Returns
A reference to this CutGeometryGatheringOptionsKit.

◆ UnsetEverything()

HPS.CutGeometryGatheringOptionsKit HPS.CutGeometryGatheringOptionsKit.UnsetEverything ( )
inline

Removes all settings from this CutGeometryGatheringOptionsKit.

Returns
A reference to this CutGeometryGatheringOptionsKit.

◆ UnsetLevel()

HPS.CutGeometryGatheringOptionsKit HPS.CutGeometryGatheringOptionsKit.UnsetLevel ( )
inline

Removes the level setting at which to collect the capping geometry.

Returns
A reference to this CutGeometryGatheringOptionsKit.

◆ UnsetOffset()

HPS.CutGeometryGatheringOptionsKit HPS.CutGeometryGatheringOptionsKit.UnsetOffset ( )
inline

Removes an offset for a single plane in a cutting section.

Returns
A reference to this CutGeometryGatheringOptionsKit.

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