API Search || Global Search
HPS.EdgeAttributeControl Class Reference

More...

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

Public Member Functions

override void Dispose ()
 
 EdgeAttributeControl (HPS.SegmentKey in_seg)
 Initializes a control tied to the segment in_seg. More...
 
 EdgeAttributeControl (HPS.EdgeAttributeControl in_that)
 Initializes a control tied to the same object as in_that. More...
 
override HPS.Type ObjectType ()
 
HPS.EdgeAttributeControl SetHardAngle (float in_angle)
 Sets the angle between adjacent faces necessary for the edge between them to be considered a hard edge. More...
 
HPS.EdgeAttributeControl SetPattern (string in_pattern_name)
 Specifies the pattern of edges. More...
 
HPS.EdgeAttributeControl SetWeight (float in_weight, HPS.Edge.SizeUnits in_units)
 Sets the weight of lines drawn in edge rendering. More...
 
HPS.EdgeAttributeControl SetWeight (float in_weight)
 Sets the weight of lines drawn in edge rendering. More...
 
bool ShowHardAngle (out float out_angle)
 Shows the weight of lines drawn in edge rendering. More...
 
bool ShowPattern (out string out_pattern_name)
 Shows the line pattern of the edges. More...
 
bool ShowWeight (out float out_weight, out HPS.Edge.SizeUnits out_units)
 Shows the weight of lines drawn in edge rendering. 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.EdgeAttributeControl 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 EdgeAttributeKit.GetDefault(). More...
 
HPS.EdgeAttributeControl UnsetHardAngle ()
 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(). More...
 
HPS.EdgeAttributeControl UnsetPattern ()
 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(). More...
 
HPS.EdgeAttributeControl UnsetWeight ()
 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(). 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 an identifier that can be used to identify which instance of a class an object is. 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.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

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

Initializes a control tied to the segment in_seg.

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

Initializes a control tied to the same object as in_that.

Member Function Documentation

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.
HPS.EdgeAttributeControl HPS.EdgeAttributeControl.SetPattern ( string  in_pattern_name)
inline

Specifies the pattern of edges.

Returns
A reference to this object.

Programming Guide: Line Patterns

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

Returns
The true type of the object in question.

Reimplemented from HPS.Control.

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