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

Public Member Functions

 CuttingSectionAttributeKit ()
 
 CuttingSectionAttributeKit (HPS.CuttingSectionAttributeKit in_kit)
 
override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.CuttingSectionAttributeKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.CuttingSectionAttributeKit in_kit)
 
HPS.CuttingSectionAttributeKit SetCappingLevel (HPS.CuttingSection.CappingLevel in_level)
 
HPS.CuttingSectionAttributeKit SetCappingUsage (HPS.CuttingSection.CappingUsage in_usage)
 
HPS.CuttingSectionAttributeKit SetCuttingLevel (HPS.CuttingSection.CuttingLevel in_level)
 
HPS.CuttingSectionAttributeKit SetEdgeWeight (float in_weight, HPS.Line.SizeUnits in_units)
 
HPS.CuttingSectionAttributeKit SetEdgeWeight (float in_weight)
 
HPS.CuttingSectionAttributeKit SetMaterialPreference (HPS.CuttingSection.MaterialPreference in_preference)
 
HPS.CuttingSectionAttributeKit SetTolerance (float in_tolerance, HPS.CuttingSection.ToleranceUnits in_units)
 
void Show (out HPS.CuttingSectionAttributeKit out_kit)
 
bool ShowCappingLevel (out HPS.CuttingSection.CappingLevel out_level)
 
bool ShowCappingUsage (out HPS.CuttingSection.CappingUsage out_usage)
 
bool ShowCuttingLevel (out HPS.CuttingSection.CuttingLevel out_level)
 
bool ShowEdgeWeight (out float out_weight, out HPS.Line.SizeUnits out_units)
 
bool ShowMaterialPreference (out HPS.CuttingSection.MaterialPreference out_preference)
 
bool ShowTolerance (out float out_tolerance, out HPS.CuttingSection.ToleranceUnits out_units)
 
HPS.CuttingSectionAttributeKit UnsetCappingLevel ()
 
HPS.CuttingSectionAttributeKit UnsetCappingUsage ()
 
HPS.CuttingSectionAttributeKit UnsetCuttingLevel ()
 
HPS.CuttingSectionAttributeKit UnsetEdgeWeight ()
 
HPS.CuttingSectionAttributeKit UnsetEverything ()
 
HPS.CuttingSectionAttributeKit UnsetMaterialPreference ()
 
HPS.CuttingSectionAttributeKit UnsetTolerance ()
 
- 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.CuttingSectionAttributeKit GetDefault ()
 
static bool operator!= (HPS.CuttingSectionAttributeKit a, HPS.CuttingSectionAttributeKit b)
 
static bool operator== (HPS.CuttingSectionAttributeKit a, HPS.CuttingSectionAttributeKit 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
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ CuttingSectionAttributeKit() [1/2]

HPS.CuttingSectionAttributeKit.CuttingSectionAttributeKit ( )
inline

Initializes an empty kit.

◆ CuttingSectionAttributeKit() [2/2]

HPS.CuttingSectionAttributeKit.CuttingSectionAttributeKit ( HPS.CuttingSectionAttributeKit  in_kit)
inline

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

Parameters
in_kitThe source object to copy.

Member Function Documentation

◆ Empty()

override bool HPS.CuttingSectionAttributeKit.Empty ( )
inlinevirtual

Indicates whether this object has any values set on it.

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

Reimplemented from HPS.Object.

◆ Equals()

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

Check if the source CuttingSectionAttributeKit is equivalent to this object.

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

◆ GetDefault()

static HPS.CuttingSectionAttributeKit HPS.CuttingSectionAttributeKit.GetDefault ( )
inlinestatic

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.

Returns
A CuttingSectionAttributeKit with the default settings.

◆ ObjectType()

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

Copies all settings from the source CuttingSectionAttributeKit into this object.

Parameters
in_kitThe source CuttingSectionAttributeKit to copy.

◆ SetCappingLevel()

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

Sets the cutting section capping level.

Parameters
in_levelThe cutting section capping level.
Returns
A reference to this object.

◆ SetCappingUsage()

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

Sets the cutting section capping usage.

Parameters
in_usageThe cutting section capping usage.
Returns
A reference to this object.

◆ SetCuttingLevel()

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

Sets the cutting section cutting level.

Parameters
in_levelThe cutting section cutting level.
Returns
A reference to this object.

◆ SetEdgeWeight() [1/2]

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

Sets the cut edge weight.

Parameters
in_weightThe edge weight to apply for cut edges.
in_unitsThe units of the weight given.
Returns
A reference to this object.

◆ SetEdgeWeight() [2/2]

HPS.CuttingSectionAttributeKit HPS.CuttingSectionAttributeKit.SetEdgeWeight ( float  in_weight)
inline

Sets the cut edge weight.

Parameters
in_weightThe edge weight to apply for cut edges.
Returns
A reference to this object.

◆ SetMaterialPreference()

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

Sets the material preference for cut geometry.

Parameters
in_preferenceThe material preference for cut geometry.
Returns
A reference to this object.

◆ SetTolerance()

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

Sets the tolerance for closing loops when processing capping faces.

Parameters
in_toleranceThe tolerance to use.
in_unitsHow to interpret the given tolerance.
Returns
A reference to this object.

◆ Show()

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

Copies all settings from this CuttingSectionAttributeKit into the given CuttingSectionAttributeKit.

Parameters
out_kitThe CuttingSectionAttributeKit to populate with the contents of this object.

◆ ShowCappingLevel()

bool HPS.CuttingSectionAttributeKit.ShowCappingLevel ( out HPS.CuttingSection.CappingLevel  out_level)
inline

Shows the cutting section capping level setting.

Parameters
out_levelThe cutting section capping level.
Returns
true if a cutting section capping level setting was specified, false otherwise.

◆ ShowCappingUsage()

bool HPS.CuttingSectionAttributeKit.ShowCappingUsage ( out HPS.CuttingSection.CappingUsage  out_usage)
inline

Shows the cutting section capping usage setting.

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

◆ ShowCuttingLevel()

bool HPS.CuttingSectionAttributeKit.ShowCuttingLevel ( out HPS.CuttingSection.CuttingLevel  out_level)
inline

Shows the cutting section cutting level setting.

Parameters
out_levelThe cutting section cutting level.
Returns
true if a cutting section cutting level setting was specified, false otherwise.

◆ ShowEdgeWeight()

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

Shows the weight of cut edges.

Parameters
out_weightThe weight value for cut edges.
out_unitsThe units applied to in_weight.
Returns
true if the setting is valid, false otherwise.

◆ ShowMaterialPreference()

bool HPS.CuttingSectionAttributeKit.ShowMaterialPreference ( out HPS.CuttingSection.MaterialPreference  out_preference)
inline

Shows the orientation of colors and radii of cylinders.

Parameters
out_preferenceThe material preference for cut geometry.
Returns
true if a material preference for cut geometry was specified, false otherwise.

◆ ShowTolerance()

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

Shows the tolerance for closing loops when processing capping faces.

Parameters
out_toleranceThe tolerance to use.
out_unitsThe units for the tolerance.
Returns
true if the setting is valid, false otherwise.

◆ UnsetCappingLevel()

HPS.CuttingSectionAttributeKit HPS.CuttingSectionAttributeKit.UnsetCappingLevel ( )
inline

Removes the cutting section capping level setting.

Returns
A reference to this object.

◆ UnsetCappingUsage()

HPS.CuttingSectionAttributeKit HPS.CuttingSectionAttributeKit.UnsetCappingUsage ( )
inline

Removes the cutting section capping usage setting.

Returns
A reference to this object.

◆ UnsetCuttingLevel()

HPS.CuttingSectionAttributeKit HPS.CuttingSectionAttributeKit.UnsetCuttingLevel ( )
inline

Removes the cutting section cutting level setting.

Returns
A reference to this object.

◆ UnsetEdgeWeight()

HPS.CuttingSectionAttributeKit HPS.CuttingSectionAttributeKit.UnsetEdgeWeight ( )
inline

Removes the cutting section cut edge weight setting.

Returns
A reference to this object.

◆ UnsetEverything()

HPS.CuttingSectionAttributeKit HPS.CuttingSectionAttributeKit.UnsetEverything ( )
inline

Removes all settings from this object.

Returns
A reference to this object.

◆ UnsetMaterialPreference()

HPS.CuttingSectionAttributeKit HPS.CuttingSectionAttributeKit.UnsetMaterialPreference ( )
inline

Removes the material preference for cut geometry setting.

Returns
A reference to this object.

◆ UnsetTolerance()

HPS.CuttingSectionAttributeKit HPS.CuttingSectionAttributeKit.UnsetTolerance ( )
inline

Removes the cutting section capping tolerance setting.

Returns
A reference to this object.

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