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

Public Member Functions

override void Dispose ()
 
 EdgeAttributeControl (HPS.SegmentKey in_seg)
 
 EdgeAttributeControl (HPS.EdgeAttributeControl in_that)
 
override HPS.Type ObjectType ()
 
HPS.EdgeAttributeControl SetHardAngle (float in_angle)
 
HPS.EdgeAttributeControl SetPattern (string in_pattern_name)
 
HPS.EdgeAttributeControl SetWeight (float in_weight, HPS.Edge.SizeUnits in_units)
 
HPS.EdgeAttributeControl SetWeight (float in_weight)
 
bool ShowHardAngle (out float out_angle)
 
bool ShowPattern (out string out_pattern_name)
 
bool ShowWeight (out float out_weight, out HPS.Edge.SizeUnits out_units)
 
override HPS.Type Type ()
 
HPS.EdgeAttributeControl UnsetEverything ()
 
HPS.EdgeAttributeControl UnsetHardAngle ()
 
HPS.EdgeAttributeControl UnsetPattern ()
 
HPS.EdgeAttributeControl UnsetWeight ()
 
- 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.EdgeAttributeControl class is a smart pointer that is tied to a database object. Using this control, you can manipulate the various attributes associated with geometry edges. Edges are present on any piece of facetted geometry.

This table lists default values for the various segment attributes accessible from HPS.EdgeAttributeControl.

Constructor & Destructor Documentation

◆ EdgeAttributeControl() [1/2]

HPS.EdgeAttributeControl.EdgeAttributeControl ( HPS.SegmentKey  in_seg)
inline

Initializes a control tied to the segment in_seg.

◆ EdgeAttributeControl() [2/2]

HPS.EdgeAttributeControl.EdgeAttributeControl ( HPS.EdgeAttributeControl  in_that)
inline

Initializes a control tied to the same object as in_that.

Member Function Documentation

◆ ObjectType()

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

◆ SetHardAngle()

HPS.EdgeAttributeControl HPS.EdgeAttributeControl.SetHardAngle ( float  in_angle)
inline

Sets the angle between adjacent faces necessary for the edge between them to be considered a hard edge.

Parameters
in_angleThe angle, in degrees, between the adjacent faces necessary for a hard edge.
Returns
A reference to this object.

◆ SetPattern()

HPS.EdgeAttributeControl HPS.EdgeAttributeControl.SetPattern ( string  in_pattern_name)
inline

Specifies the pattern of edges.

Returns
A reference to this object.
See also
Programming Guide: Line Patterns

◆ SetWeight() [1/2]

HPS.EdgeAttributeControl HPS.EdgeAttributeControl.SetWeight ( float  in_weight,
HPS.Edge.SizeUnits  in_units 
)
inline

Sets the weight of lines drawn in edge rendering.

Parameters
in_weightThe weight value for edges.
in_unitsThe units applied to in_weight.
Returns
A reference to this object.

◆ SetWeight() [2/2]

HPS.EdgeAttributeControl HPS.EdgeAttributeControl.SetWeight ( float  in_weight)
inline

Sets the weight of lines drawn in edge rendering.

Parameters
in_weightThe weight value for edges.
Returns
A reference to this object.

◆ ShowHardAngle()

bool HPS.EdgeAttributeControl.ShowHardAngle ( out float  out_angle)
inline

Shows the weight of lines drawn in edge rendering.

Parameters
out_angleThe angle, in degrees, between the adjacent faces necessary for a hard edge.
Returns
true if the setting is valid, false otherwise.

◆ ShowPattern()

bool HPS.EdgeAttributeControl.ShowPattern ( out string  out_pattern_name)
inline

Shows the line pattern of the edges.

Returns
true if the setting is valid, false otherwise.

◆ ShowWeight()

bool HPS.EdgeAttributeControl.ShowWeight ( out float  out_weight,
out HPS.Edge.SizeUnits  out_units 
)
inline

Shows the weight of lines drawn in edge rendering.

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

◆ Type()

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

◆ UnsetEverything()

HPS.EdgeAttributeControl HPS.EdgeAttributeControl.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 EdgeAttributeKit.GetDefault().

Returns
A reference to this object.

◆ UnsetHardAngle()

HPS.EdgeAttributeControl HPS.EdgeAttributeControl.UnsetHardAngle ( )
inline

Removes the hard edge angle setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by EdgeAttributeKit.GetDefault().

Returns
A reference to this object.

◆ UnsetPattern()

HPS.EdgeAttributeControl HPS.EdgeAttributeControl.UnsetPattern ( )
inline

Removes the line pattern setting for edges. If the control is attached to a WindowKey this function restores the default value of this setting as specified by EdgeAttributeKit.GetDefault().

Returns
A reference to this object.

◆ UnsetWeight()

HPS.EdgeAttributeControl HPS.EdgeAttributeControl.UnsetWeight ( )
inline

Removes the weight setting for edges. If the control is attached to a WindowKey this function restores the default value of this setting as specified by EdgeAttributeKit.GetDefault().

Returns
A reference to this object.

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