Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
HPS.CutGeometryGatheringOptionsKit Class Reference
Inheritance diagram for HPS.CutGeometryGatheringOptionsKit:
HPS.Object

Public Member Functions

override void Dispose ()
 
 CutGeometryGatheringOptionsKit ()
 The default constructor creates an empty CutGeometryGatheringOptionsKit object. More...
 
 CutGeometryGatheringOptionsKit (HPS.CutGeometryGatheringOptionsKit in_kit)
 The copy constructor creates a new CutGeometryGatheringOptionsKit object that contains the same settings as the source CutGeometryGatheringOptionsKit. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
void Set (HPS.CutGeometryGatheringOptionsKit in_kit)
 Copies the source CutGeometryGatheringOptionsKit into this CutGeometryGatheringOptionsKit. More...
 
void Show (out HPS.CutGeometryGatheringOptionsKit out_kit)
 Copies this CutGeometryGatheringOptionsKit into the given CutGeometryGatheringOptionsKit. More...
 
override bool Empty ()
 Indicates whether this CutGeometryGatheringOptionsKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
override int GetHashCode ()
 
bool Equals (HPS.CutGeometryGatheringOptionsKit in_kit)
 Check if the source CutGeometryGatheringOptionsKit is equivalent to this CutGeometryGatheringOptionsKit. More...
 
HPS.CutGeometryGatheringOptionsKit SetCuttingSection (HPS.CuttingSectionKey in_cutter)
 Sets a single cutting section for which to collect capping geometry. If this is not specified, caps for all cutting sections will be collected. More...
 
HPS.CutGeometryGatheringOptionsKit SetOffset (ulong in_offset)
 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. More...
 
HPS.CutGeometryGatheringOptionsKit SetLevel (HPS.CuttingSection.GatheringLevel in_level)
 Sets the level at which to collect the capping geometry. More...
 
HPS.CutGeometryGatheringOptionsKit UnsetCuttingSection ()
 Removes a single cutting section for which to collect capping geometry. More...
 
HPS.CutGeometryGatheringOptionsKit UnsetOffset ()
 Removes an offset for a single plane in a cutting section. More...
 
HPS.CutGeometryGatheringOptionsKit UnsetLevel ()
 Removes the level setting at which to collect the capping geometry. More...
 
HPS.CutGeometryGatheringOptionsKit UnsetEverything ()
 Removes all settings from this CutGeometryGatheringOptionsKit. More...
 
bool ShowCuttingSection (out HPS.CuttingSectionKey out_cutter)
 Shows a cutting section that is interesting for capping geometry collection. More...
 
bool ShowOffset (out ulong out_offset)
 Shows an offset for a single plane in a cutting section. More...
 
bool ShowLevel (out HPS.CuttingSection.GatheringLevel out_level)
 Shows the level at which to collect the capping geometry. More...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
HPS.Type Type ()
 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. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More...
 

Static Public Member Functions

static
HPS.CutGeometryGatheringOptionsKit 
GetDefault ()
 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. More...
 
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.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
HandleRef cptr
 
HandleRef scptr
 
bool cMemOwn
 

Constructor & Destructor Documentation

HPS.CutGeometryGatheringOptionsKit.CutGeometryGatheringOptionsKit ( )
inline

The default constructor creates an empty CutGeometryGatheringOptionsKit object.

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 <ref refid="class_h_p_s_1_1_cut_geometry_gathering_options_kit" kindref="compound">CutGeometryGatheringOptionsKit</ref> to copy.

Member Function Documentation

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.

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

Check if the source CutGeometryGatheringOptionsKit is equivalent to this CutGeometryGatheringOptionsKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_cut_geometry_gathering_options_kit" kindref="compound">CutGeometryGatheringOptionsKit</ref> to compare to this <ref refid="class_h_p_s_1_1_cut_geometry_gathering_options_kit" kindref="compound">CutGeometryGatheringOptionsKit</ref>.
Returns
true if the objects are equivalent, false otherwise.
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.
override HPS.Type HPS.CutGeometryGatheringOptionsKit.ObjectType ( )
inlinevirtual

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.

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

Copies the source CutGeometryGatheringOptionsKit into this CutGeometryGatheringOptionsKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_cut_geometry_gathering_options_kit" kindref="compound">CutGeometryGatheringOptionsKit</ref> to copy.
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.
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.
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.
void HPS.CutGeometryGatheringOptionsKit.Show ( out HPS.CutGeometryGatheringOptionsKit  out_kit)
inline

Copies this CutGeometryGatheringOptionsKit into the given CutGeometryGatheringOptionsKit.

Parameters
out_kitThe <ref refid="class_h_p_s_1_1_cut_geometry_gathering_options_kit" kindref="compound">CutGeometryGatheringOptionsKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_cut_geometry_gathering_options_kit" kindref="compound">CutGeometryGatheringOptionsKit</ref>.
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.
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.
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.
HPS.CutGeometryGatheringOptionsKit HPS.CutGeometryGatheringOptionsKit.UnsetCuttingSection ( )
inline

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

Returns
A reference to this CutGeometryGatheringOptionsKit.
HPS.CutGeometryGatheringOptionsKit HPS.CutGeometryGatheringOptionsKit.UnsetEverything ( )
inline

Removes all settings from this CutGeometryGatheringOptionsKit.

Returns
A reference to this CutGeometryGatheringOptionsKit.
HPS.CutGeometryGatheringOptionsKit HPS.CutGeometryGatheringOptionsKit.UnsetLevel ( )
inline

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

Returns
A reference to this CutGeometryGatheringOptionsKit.
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: