Inheritance diagram for HPS.EdgeAttributeKit:
HPS.Kit HPS.Object

Public Member Functions

override void Dispose ()
 
 EdgeAttributeKit ()
 
 EdgeAttributeKit (HPS.EdgeAttributeKit in_kit)
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.EdgeAttributeKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.EdgeAttributeKit in_kit)
 
HPS.EdgeAttributeKit SetHardAngle (float in_angle)
 
HPS.EdgeAttributeKit SetPattern (string in_pattern_name)
 
HPS.EdgeAttributeKit SetWeight (float in_weight, HPS.Edge.SizeUnits in_units)
 
HPS.EdgeAttributeKit SetWeight (float in_weight)
 
void Show (out HPS.EdgeAttributeKit out_kit)
 
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)
 
HPS.EdgeAttributeKit UnsetEverything ()
 
HPS.EdgeAttributeKit UnsetHardAngle ()
 
HPS.EdgeAttributeKit UnsetPattern ()
 
HPS.EdgeAttributeKit UnsetWeight ()
 
- Public Member Functions inherited from HPS.Kit
override void Dispose ()
 
 Kit (HPS.Kit in_that)
 
override HPS.Type ObjectType ()
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static HPS.EdgeAttributeKit GetDefault ()
 
static bool operator!= (HPS.EdgeAttributeKit a, HPS.EdgeAttributeKit b)
 
static bool operator== (HPS.EdgeAttributeKit a, HPS.EdgeAttributeKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The HPS.EdgeAttributeKit class is a user space object, useful for carrying a group attribute settings. Calling HPS.EdgeAttributeKit.GetDefault() will return a kit with values found in this table.

Constructor & Destructor Documentation

◆ EdgeAttributeKit() [1/2]

HPS.EdgeAttributeKit.EdgeAttributeKit ( )
inline

Initializes an empty kit.

◆ EdgeAttributeKit() [2/2]

HPS.EdgeAttributeKit.EdgeAttributeKit ( HPS.EdgeAttributeKit  in_kit)
inline

The copy constructor creates a new EdgeAttributeKit object that contains the same settings as the source object.

Parameters
in_kitThe source object to copy.

Member Function Documentation

◆ Empty()

override bool HPS.EdgeAttributeKit.Empty ( )
inlinevirtual

Indicates whether this object has any values set on it.

Returns
true if no values are set on this object, false otherwise.

Reimplemented from HPS.Object.

◆ Equals()

bool HPS.EdgeAttributeKit.Equals ( HPS.EdgeAttributeKit  in_kit)
inline

Check if the source EdgeAttributeKit is equivalent to this object.

Parameters
in_kitThe source EdgeAttributeKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static HPS.EdgeAttributeKit HPS.EdgeAttributeKit.GetDefault ( )
inlinestatic

Creates a EdgeAttributeKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.

Returns
A EdgeAttributeKit with the default settings.

◆ ObjectType()

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

◆ Set()

void HPS.EdgeAttributeKit.Set ( HPS.EdgeAttributeKit  in_kit)
inline

Copies all settings from the source EdgeAttributeKit into this object.

Parameters
in_kitThe source EdgeAttributeKit to copy.

◆ SetHardAngle()

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

◆ Show()

void HPS.EdgeAttributeKit.Show ( out HPS.EdgeAttributeKit  out_kit)
inline

Copies all settings from this EdgeAttributeKit into the given EdgeAttributeKit.

Parameters
out_kitThe EdgeAttributeKit to populate with the contents of this object.

◆ ShowHardAngle()

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

◆ UnsetEverything()

HPS.EdgeAttributeKit HPS.EdgeAttributeKit.UnsetEverything ( )
inline

Removes all settings from this object.

Returns
A reference to this object.

◆ UnsetHardAngle()

HPS.EdgeAttributeKit HPS.EdgeAttributeKit.UnsetHardAngle ( )
inline

Removes the hard edge angle setting.

Returns
A reference to this object.

◆ UnsetPattern()

HPS.EdgeAttributeKit HPS.EdgeAttributeKit.UnsetPattern ( )
inline

Removes the line pattern setting for edges.

Returns
A reference to this object.

◆ UnsetWeight()

HPS.EdgeAttributeKit HPS.EdgeAttributeKit.UnsetWeight ( )
inline

Removes the weight setting for edges.

Returns
A reference to this object.

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