CutGeometryGatheringOptionsKit

class HPS.CutGeometryGatheringOptionsKit : HPS.Kit

Public Functions

CutGeometryGatheringOptionsKit ()

The default constructor creates an empty CutGeometryGatheringOptionsKit object.

CutGeometryGatheringOptionsKit (HPS.CutGeometryGatheringOptionsKit in_kit)

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

Param in_kit:The source CutGeometryGatheringOptionsKit to copy.

override void Dispose ()

override bool Empty ()

Indicates whether this CutGeometryGatheringOptionsKit has any values set on it.

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

bool Equals (HPS.CutGeometryGatheringOptionsKit in_kit)

Check if the source CutGeometryGatheringOptionsKit is equivalent to this CutGeometryGatheringOptionsKit.

Param in_kit:The source CutGeometryGatheringOptionsKit to compare to this CutGeometryGatheringOptionsKit. 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.CutGeometryGatheringOptionsKit in_kit)

Copies the source CutGeometryGatheringOptionsKit into this CutGeometryGatheringOptionsKit.

Param in_kit:The source CutGeometryGatheringOptionsKit to copy.

HPS.CutGeometryGatheringOptionsKit SetColor (bool in_color)

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

Param in_color:Whether the color is collected. Return:A reference to this CutGeometryGatheringOptionsKit.

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.

Param in_cutter:  A single cutting section that is interesting for capping geometry collection. Return:A reference to this CutGeometryGatheringOptionsKit.

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

Sets the level at which to collect the capping geometry.

Param in_level:Whether the capping geometry should be collected from just a single segment or an entire subtree. Return:A reference to this CutGeometryGatheringOptionsKit.

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.

Param in_offset:  An offset for a single plane in a cutting section. Return:A reference to this CutGeometryGatheringOptionsKit.

void Show (out HPS.CutGeometryGatheringOptionsKit out_kit)

Copies this CutGeometryGatheringOptionsKit into the given CutGeometryGatheringOptionsKit.

Param out_kit:The CutGeometryGatheringOptionsKit to populate with the contents of this CutGeometryGatheringOptionsKit.

bool ShowColor (out bool out_color)

Shows the color gathering preference whe collecting capping geometry.

Param out_color:  Whether the implicit color of the capping geometry should be collected along with the geometry. Return:true if a color gathering preference was set, false otherwise.

bool ShowCuttingSection (out HPS.CuttingSectionKey out_cutter)

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

Param out_cutter:  A cutting section that is interesting for capping geometry collection. Return:true if a cutting section was set, false otherwise.

bool ShowLevel (out HPS.CuttingSection.GatheringLevel out_level)

Shows the level at which to collect the capping geometry.

Param out_level:  Whether the capping geometry should be collected from just a single segment or an entire subtree. Return:true if a level was set, false otherwise.

bool ShowOffset (out ulong out_offset)

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

Param out_offset:  An offset for a single plane in a cutting section. Return:true if an offset was set, false otherwise.

HPS.CutGeometryGatheringOptionsKit UnsetColor ()

Removes the color setting when collecting the capping geometry.

Return:A reference to this CutGeometryGatheringOptionsKit.

HPS.CutGeometryGatheringOptionsKit UnsetCuttingSection ()

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

Return:A reference to this CutGeometryGatheringOptionsKit.

HPS.CutGeometryGatheringOptionsKit UnsetEverything ()

Removes all settings from this CutGeometryGatheringOptionsKit.

Return:A reference to this CutGeometryGatheringOptionsKit.

HPS.CutGeometryGatheringOptionsKit UnsetLevel ()

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

Return:A reference to this CutGeometryGatheringOptionsKit.

HPS.CutGeometryGatheringOptionsKit UnsetOffset ()

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

Return:A reference to this CutGeometryGatheringOptionsKit.

Public Static Functions

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.

Return:A CutGeometryGatheringOptionsKit with the default settings.

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

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