< Home

< Table of Contents

REFERENCE MANUAL

HPS.EdgeAttributeControl Class Reference

The EdgeAttributeControl class is a smart pointer that is tied to a database object. 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 ()
 This function returns the type the object, as declared. 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 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...
 
HPS.EdgeAttributeControl UnsetEverything ()
 Removes all settings from this object. More...
 
HPS.EdgeAttributeControl UnsetPattern ()
 Removes the line pattern setting for edges. More...
 
HPS.EdgeAttributeControl UnsetWeight ()
 Removes the weight setting for edges. 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. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. 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
 
HandleRef scptr
 

Detailed Description

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

Constructor & Destructor Documentation

HPS.EdgeAttributeControl.EdgeAttributeControl ( HPS.SegmentKey  in_seg)

Initializes a control tied to the segment in_seg.

HPS.EdgeAttributeControl.EdgeAttributeControl ( HPS.EdgeAttributeControl  in_that)

Initializes a control tied to the same object as in_that.

Member Function Documentation

override HPS.Type HPS.EdgeAttributeControl.ObjectType ( )
virtual

This function returns the type the object, as declared.

This does not necessarily give the true type of the underlying object.

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Object.

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

Specifies the pattern of edges.

Returns
A reference to this object.
HPS.EdgeAttributeControl HPS.EdgeAttributeControl.SetWeight ( float  in_weight,
HPS.Edge.SizeUnits  in_units 
)

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)

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.ShowPattern ( out string  out_pattern_name)

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 
)

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

Removes all settings from this object.

Returns
A reference to this object.
HPS.EdgeAttributeControl HPS.EdgeAttributeControl.UnsetPattern ( )

Removes the line pattern setting for edges.

Returns
A reference to this object.
HPS.EdgeAttributeControl HPS.EdgeAttributeControl.UnsetWeight ( )

Removes the weight setting for edges.

Returns
A reference to this object.

The documentation for this class was generated from the following file: