CuttingSectionAttributeKit

class HPS.CuttingSectionAttributeKit : public HPS.Kit 

The HPS.CuttingSectionAttributeKit class is a user space object which encapsulates a set of attributes pertaining to cutting sections. Calling HPS.CuttingSectionAttributeKit.GetDefault() will return a kit with values found in this table.

Public Functions

CuttingSectionAttributeKit (): Initializes an empty kit.

CuttingSectionAttributeKit (HPS.CuttingSectionAttributeKit in_kit)

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

Param in_kit: The source object to copy.

override void Dispose ()

override bool Empty ()

Indicates whether this object has any values set on it.

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

bool Equals (HPS.CuttingSectionAttributeKit in_kit)

Check if the source CuttingSectionAttributeKit is equivalent to this object.

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

Copies all settings from the source CuttingSectionAttributeKit into this object.

Param in_kit: The source CuttingSectionAttributeKit to copy.

HPS.CuttingSectionAttributeKit SetCappingLevel (HPS.CuttingSection.CappingLevel in_level)

Sets the cutting section capping level.

Param in_level: The cutting section capping level.
Return: A reference to this object.

HPS.CuttingSectionAttributeKit SetCappingUsage (HPS.CuttingSection.CappingUsage in_usage)

Sets the cutting section capping usage.

Param in_usage: The cutting section capping usage.
Return: A reference to this object.

HPS.CuttingSectionAttributeKit SetCuttingLevel (HPS.CuttingSection.CuttingLevel in_level)

Sets the cutting section cutting level.

Param in_level: The cutting section cutting level.
Return: A reference to this object.

HPS.CuttingSectionAttributeKit SetEdgeWeight (float in_weight)

Sets the cut edge weight.

Param in_weight: The edge weight to apply for cut edges.
Return: A reference to this object.

HPS.CuttingSectionAttributeKit SetEdgeWeight (float in_weight, HPS.Line.SizeUnits in_units)

Sets the cut edge weight.

Param in_weight: The edge weight to apply for cut edges.
Param in_units: The units of the weight given.
Return: A reference to this object.

HPS.CuttingSectionAttributeKit SetMaterialPreference (HPS.CuttingSection.MaterialPreference in_preference)

Sets the material preference for cut geometry.

Param in_preference: The material preference for cut geometry.
Return: A reference to this object.

HPS.CuttingSectionAttributeKit SetTolerance (float in_tolerance, HPS.CuttingSection.ToleranceUnits in_units)

Sets the tolerance for closing loops when processing capping faces.

Param in_tolerance: The tolerance to use.
Param in_units: How to interpret the given tolerance.
Return: A reference to this object.

void Show (out HPS.CuttingSectionAttributeKit out_kit)

Copies all settings from this CuttingSectionAttributeKit into the given CuttingSectionAttributeKit.

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

bool ShowCappingLevel (out HPS.CuttingSection.CappingLevel out_level)

Shows the cutting section capping level setting.

Param out_level: The cutting section capping level.
Return: true if a cutting section capping level setting was specified, false otherwise.

bool ShowCappingUsage (out HPS.CuttingSection.CappingUsage out_usage)

Shows the cutting section capping usage setting.

Return: true if a cutting section capping usage setting was specified, false otherwise.

bool ShowCuttingLevel (out HPS.CuttingSection.CuttingLevel out_level)

Shows the cutting section cutting level setting.

Param out_level: The cutting section cutting level.
Return: true if a cutting section cutting level setting was specified, false otherwise.

bool ShowEdgeWeight (out float out_weight, out HPS.Line.SizeUnits out_units)

Shows the weight of cut edges.

Param out_weight: The weight value for cut edges.
Param out_units: The units applied to in_weight.
Return: true if the setting is valid, false otherwise.

bool ShowMaterialPreference (out HPS.CuttingSection.MaterialPreference out_preference)

Shows the orientation of colors and radii of cylinders.

Param out_preference: The material preference for cut geometry.
Return: true if a material preference for cut geometry was specified, false otherwise.

bool ShowTolerance (out float out_tolerance, out HPS.CuttingSection.ToleranceUnits out_units)

Shows the tolerance for closing loops when processing capping faces.

Param out_tolerance: The tolerance to use.
Param out_units: The units for the tolerance.
Return: true if the setting is valid, false otherwise.

HPS.CuttingSectionAttributeKit UnsetCappingLevel ()

Removes the cutting section capping level setting.

Return: A reference to this object.

HPS.CuttingSectionAttributeKit UnsetCappingUsage ()

Removes the cutting section capping usage setting.

Return: A reference to this object.

HPS.CuttingSectionAttributeKit UnsetCuttingLevel ()

Removes the cutting section cutting level setting.

Return: A reference to this object.

HPS.CuttingSectionAttributeKit UnsetEdgeWeight ()

Removes the cutting section cut edge weight setting.

Return: A reference to this object.

HPS.CuttingSectionAttributeKit UnsetEverything ()

Removes all settings from this object.

Return: A reference to this object.

HPS.CuttingSectionAttributeKit UnsetMaterialPreference ()

Removes the material preference for cut geometry setting.

Return: A reference to this object.

HPS.CuttingSectionAttributeKit UnsetTolerance ()

Removes the cutting section capping tolerance setting.

Return: A reference to this object.

Public Static Functions

HPS.CuttingSectionAttributeKit GetDefault ()

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

bool operator!= (HPS.CuttingSectionAttributeKit a, HPS.CuttingSectionAttributeKit b)

bool operator== (HPS.CuttingSectionAttributeKit a, HPS.CuttingSectionAttributeKit b)