EdgeAttributeKit

class HPS.EdgeAttributeKit : HPS.Kit

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.

Public Functions

override void Dispose ()

EdgeAttributeKit ()

Initializes an empty kit.

EdgeAttributeKit (HPS.EdgeAttributeKit in_kit)

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

Param in_kit:The source object to copy.

override bool Empty ()

Indicates whether this object has any values set on it.

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

bool Equals (HPS.EdgeAttributeKit in_kit)

Check if the source EdgeAttributeKit is equivalent to this object.

Param in_kit:The source EdgeAttributeKit to compare to this object. Return:true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

override HPS.Type ObjectType ()

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

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

void Set (HPS.EdgeAttributeKit in_kit)

Copies all settings from the source EdgeAttributeKit into this object.

Param in_kit:The source EdgeAttributeKit to copy.

HPS.EdgeAttributeKit SetHardAngle (float in_angle)

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

Param in_angle:The angle, in degrees, between the adjacent faces necessary for a hard edge. Return:A reference to this object.

HPS.EdgeAttributeKit SetPattern (string in_pattern_name)

Specifies the pattern of edges.

See also

Programming Guide: Line Patterns

Return:A reference to this object.

HPS.EdgeAttributeKit SetWeight (float in_weight)

Sets the weight of lines drawn in edge rendering.

Param in_weight:  The weight value for edges. Return:A reference to this object.

HPS.EdgeAttributeKit SetWeight (float in_weight, HPS.Edge.SizeUnits in_units)

Sets the weight of lines drawn in edge rendering.

Param in_weight:  The weight value for edges. Param in_units:The units applied to in_weight. Return:A reference to this object.

void Show (out HPS.EdgeAttributeKit out_kit)

Copies all settings from this EdgeAttributeKit into the given EdgeAttributeKit.

Param out_kit:The EdgeAttributeKit to populate with the contents of this object.

bool ShowHardAngle (out float out_angle)

Shows the weight of lines drawn in edge rendering.

Param out_angle:  The angle, in degrees, between the adjacent faces necessary for a hard edge. Return:true if the setting is valid, false otherwise.

bool ShowPattern (out string out_pattern_name)

Shows the line pattern of the edges.

Return:true if the setting is valid, false otherwise.

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

Shows the weight of lines drawn in edge rendering.

Param out_weight:  The weight value for edges. Param out_units:  The units applied to in_weight. Return:true if the setting is valid, false otherwise.

HPS.EdgeAttributeKit UnsetEverything ()

Removes all settings from this object.

Return:A reference to this object.

HPS.EdgeAttributeKit UnsetHardAngle ()

Removes the hard edge angle setting.

Return:A reference to this object.

HPS.EdgeAttributeKit UnsetPattern ()

Removes the line pattern setting for edges.

Return:A reference to this object.

HPS.EdgeAttributeKit UnsetWeight ()

Removes the weight setting for edges.

Return:A reference to this object.

Public Static Functions

HPS.EdgeAttributeKit GetDefault ()

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.

Return:A EdgeAttributeKit with the default settings.

bool operator!= (HPS.EdgeAttributeKit a, HPS.EdgeAttributeKit b)

bool operator== (HPS.EdgeAttributeKit a, HPS.EdgeAttributeKit b)