HPS.CuttingSectionAttributeControl Class Reference
Inheritance diagram for HPS.CuttingSectionAttributeControl:
HPS.Control HPS.Object

Public Member Functions

 CuttingSectionAttributeControl (HPS.SegmentKey in_seg)
 
 CuttingSectionAttributeControl (HPS.CuttingSectionAttributeControl in_that)
 
override void Dispose ()
 
override HPS.Type ObjectType ()
 
HPS.CuttingSectionAttributeControl SetCappingLevel (HPS.CuttingSection.CappingLevel in_level)
 
HPS.CuttingSectionAttributeControl SetCappingUsage (HPS.CuttingSection.CappingUsage in_usage)
 
HPS.CuttingSectionAttributeControl SetCuttingLevel (HPS.CuttingSection.CuttingLevel in_level)
 
HPS.CuttingSectionAttributeControl SetEdgeWeight (float in_weight, HPS.Line.SizeUnits in_units)
 
HPS.CuttingSectionAttributeControl SetEdgeWeight (float in_weight)
 
HPS.CuttingSectionAttributeControl SetMaterialPreference (HPS.CuttingSection.MaterialPreference in_preference)
 
HPS.CuttingSectionAttributeControl SetTolerance (float in_tolerance, HPS.CuttingSection.ToleranceUnits in_units)
 
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)
 
override HPS.Type Type ()
 
HPS.CuttingSectionAttributeControl UnsetCappingLevel ()
 
HPS.CuttingSectionAttributeControl UnsetCappingUsage ()
 
HPS.CuttingSectionAttributeControl UnsetCuttingLevel ()
 
HPS.CuttingSectionAttributeControl UnsetEdgeWeight ()
 
HPS.CuttingSectionAttributeControl UnsetEverything ()
 
HPS.CuttingSectionAttributeControl UnsetMaterialPreference ()
 
HPS.CuttingSectionAttributeControl UnsetTolerance ()
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The HPS.CuttingSectionAttributeControl class is a smart pointer that is tied to a database object. This object is used to manipulate the various cutting section attributes. This table lists default values for the various segment attributes accessible from HPS.CuttingSectionAttributeControl.

Constructor & Destructor Documentation

◆ CuttingSectionAttributeControl() [1/2]

HPS.CuttingSectionAttributeControl.CuttingSectionAttributeControl ( HPS.SegmentKey  in_seg)
inline

Initializes a control tied to the segment in_seg.

◆ CuttingSectionAttributeControl() [2/2]

HPS.CuttingSectionAttributeControl.CuttingSectionAttributeControl ( HPS.CuttingSectionAttributeControl  in_that)
inline

Initializes a control tied to the same object as in_that.

Member Function Documentation

◆ ObjectType()

override HPS.Type HPS.CuttingSectionAttributeControl.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.Control.

◆ SetCappingLevel()

HPS.CuttingSectionAttributeControl HPS.CuttingSectionAttributeControl.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.CuttingSectionAttributeControl HPS.CuttingSectionAttributeControl.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.CuttingSectionAttributeControl HPS.CuttingSectionAttributeControl.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.CuttingSectionAttributeControl HPS.CuttingSectionAttributeControl.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.CuttingSectionAttributeControl HPS.CuttingSectionAttributeControl.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.CuttingSectionAttributeControl HPS.CuttingSectionAttributeControl.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.CuttingSectionAttributeControl HPS.CuttingSectionAttributeControl.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.

◆ ShowCappingLevel()

bool HPS.CuttingSectionAttributeControl.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.CuttingSectionAttributeControl.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.CuttingSectionAttributeControl.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.CuttingSectionAttributeControl.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.CuttingSectionAttributeControl.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.CuttingSectionAttributeControl.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.

◆ Type()

override HPS.Type HPS.CuttingSectionAttributeControl.Type ( )
inlinevirtual

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.

Warning
This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
Returns
The true type of the object in question.

Reimplemented from HPS.Control.

◆ UnsetCappingLevel()

HPS.CuttingSectionAttributeControl HPS.CuttingSectionAttributeControl.UnsetCappingLevel ( )
inline

Removes the cutting section capping level setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CuttingSectionAttributeKit.GetDefault().

Returns
A reference to this object.

◆ UnsetCappingUsage()

HPS.CuttingSectionAttributeControl HPS.CuttingSectionAttributeControl.UnsetCappingUsage ( )
inline

Removes the cutting section capping usage setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CuttingSectionAttributeKit.GetDefault().

Returns
A reference to this object.

◆ UnsetCuttingLevel()

HPS.CuttingSectionAttributeControl HPS.CuttingSectionAttributeControl.UnsetCuttingLevel ( )
inline

Removes the cutting section cutting level setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CuttingSectionAttributeKit.GetDefault().

Returns
A reference to this object.

◆ UnsetEdgeWeight()

HPS.CuttingSectionAttributeControl HPS.CuttingSectionAttributeControl.UnsetEdgeWeight ( )
inline

Removes the cutting section cut edge weight setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CuttingSectionAttributeKit.GetDefault().

Returns
A reference to this object.

◆ UnsetEverything()

HPS.CuttingSectionAttributeControl HPS.CuttingSectionAttributeControl.UnsetEverything ( )
inline

Removes all settings from this object. If the control is attached to a WindowKey this function restores the default settings of this control as specified by CuttingSectionAttributeKit.GetDefault().

Returns
A reference to this object.

◆ UnsetMaterialPreference()

HPS.CuttingSectionAttributeControl HPS.CuttingSectionAttributeControl.UnsetMaterialPreference ( )
inline

Removes the material preference for cut geometry setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CuttingSectionAttributeKit.GetDefault().

Returns
A reference to this object.

◆ UnsetTolerance()

HPS.CuttingSectionAttributeControl HPS.CuttingSectionAttributeControl.UnsetTolerance ( )
inline

Removes the cutting section capping tolerance setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CuttingSectionAttributeKit.GetDefault().

Returns
A reference to this object.

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