API Search || Global Search
HPS.CuttingSectionAttributeControl Class Reference

More...

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

Public Member Functions

 CuttingSectionAttributeControl (HPS.SegmentKey in_seg)
 Initializes a control tied to the segment in_seg. More...
 
 CuttingSectionAttributeControl (HPS.CuttingSectionAttributeControl in_that)
 Initializes a control tied to the same object as in_that. More...
 
override void Dispose ()
 
override HPS.Type ObjectType ()
 
HPS.CuttingSectionAttributeControl SetCappingLevel (HPS.CuttingSection.CappingLevel in_level)
 Sets the cutting section capping level. More...
 
HPS.CuttingSectionAttributeControl SetCuttingLevel (HPS.CuttingSection.CuttingLevel in_level)
 Sets the cutting section cutting level. More...
 
HPS.CuttingSectionAttributeControl SetEdgeWeight (float in_weight, HPS.Line.SizeUnits in_units)
 Sets the cut edge weight. More...
 
HPS.CuttingSectionAttributeControl SetEdgeWeight (float in_weight)
 Sets the cut edge weight. More...
 
HPS.CuttingSectionAttributeControl SetMaterialPreference (HPS.CuttingSection.MaterialPreference in_preference)
 Sets the material preference for cut geometry. More...
 
HPS.CuttingSectionAttributeControl SetTolerance (float in_tolerance, HPS.CuttingSection.ToleranceUnits in_units)
 Sets the tolerance for closing loops when processing capping faces. More...
 
bool ShowCappingLevel (out HPS.CuttingSection.CappingLevel out_level)
 Shows the cutting section capping level setting. More...
 
bool ShowCuttingLevel (out HPS.CuttingSection.CuttingLevel out_level)
 Shows the cutting section cutting level setting. More...
 
bool ShowEdgeWeight (out float out_weight, out HPS.Line.SizeUnits out_units)
 Shows the weight of cut edges. More...
 
bool ShowMaterialPreference (out HPS.CuttingSection.MaterialPreference out_preference)
 Shows the orientation of colors and radii of cylinders. More...
 
bool ShowTolerance (out float out_tolerance, out HPS.CuttingSection.ToleranceUnits out_units)
 Shows the tolerance for closing loops when processing capping faces. More...
 
override 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...
 
HPS.CuttingSectionAttributeControl UnsetCappingLevel ()
 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(). More...
 
HPS.CuttingSectionAttributeControl UnsetCuttingLevel ()
 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(). More...
 
HPS.CuttingSectionAttributeControl UnsetEdgeWeight ()
 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(). More...
 
HPS.CuttingSectionAttributeControl UnsetEverything ()
 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(). More...
 
HPS.CuttingSectionAttributeControl UnsetMaterialPreference ()
 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(). More...
 
HPS.CuttingSectionAttributeControl UnsetTolerance ()
 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(). More...
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object that)
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 

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

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

Initializes a control tied to the segment in_seg.

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

Initializes a control tied to the same object as in_that.

Member Function Documentation

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

Returns
The true type of the object in question.

Reimplemented from HPS.Control.

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