EdgeAttributeControl

class HPS::EdgeAttributeControl : public HPS::Control

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.

Public Functions

EdgeAttributeControl(EdgeAttributeControl &&in_that)

The move constructor creates an EdgeAttributeControl by transferring the underlying impl of the rvalue reference to this EdgeAttributeControl thereby avoiding a copy and allocation.

Parameters

in_that – An rvalue reference to an EdgeAttributeControl to take the impl from.

EdgeAttributeControl(EdgeAttributeControl const &in_that)

Initializes a control tied to the same object as in_that.

explicit EdgeAttributeControl(SegmentKey &in_seg)

Initializes a control tied to the segment in_seg.

inline virtual HPS::Type ObjectType() const

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.

EdgeAttributeControl &operator=(EdgeAttributeControl &&in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this EdgeAttributeControl thereby avoiding a copy.

Parameters

in_that – An rvalue reference to an EdgeAttributeControl to take the impl from.

Returns

A reference to this EdgeAttributeControl.

EdgeAttributeControl &operator=(EdgeAttributeControl const &in_that)

Share the underlying smart-pointer of the EdgeAttributeControl source.

Parameters

in_that – The EdgeAttributeControl source of the assignment.

Returns

A reference to this EdgeAttributeControl.

EdgeAttributeControl &SetHardAngle(float in_angle)

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

Parameters

in_angle – The angle, in degrees, between the adjacent faces necessary for a hard edge.

Returns

A reference to this object.

EdgeAttributeControl &SetPattern(char const *in_pattern_name)

Specifies the pattern of edges.

See

Programming Guide: Line Patterns

Parameters

in_pattern – The name of a line pattern, defined in a portfolio that is accessible.

Returns

A reference to this object.

EdgeAttributeControl &SetWeight(float in_weight, Edge::SizeUnits in_units = Edge::SizeUnits::ScaleFactor)

Sets the weight of lines drawn in edge rendering.

Parameters

  • in_weight – The weight value for edges.

  • in_units – The units applied to in_weight.

Returns

A reference to this object.

bool ShowHardAngle(float &out_angle) const

Shows the weight of lines drawn in edge rendering.

Parameters

out_angle – The angle, in degrees, between the adjacent faces necessary for a hard edge.

Returns

true if the setting is valid, false otherwise.

bool ShowPattern(UTF8 &out_pattern_name) const

Shows the line pattern of the edges.

Parameters

out_pattern – The name of a line pattern, defined in a portfolio that is accessible.

Returns

true if the setting is valid, false otherwise.

bool ShowWeight(float &out_weight, Edge::SizeUnits &out_units) const

Shows the weight of lines drawn in edge rendering.

Parameters

  • out_weight – The weight value for edges.

  • out_units – The units applied to in_weight.

Returns

true if the setting is valid, false otherwise.

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

Returns

A reference to this object.

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

Returns

A reference to this object.

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

Returns

A reference to this object.

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

Returns

A reference to this object.

~EdgeAttributeControl()

Releases a reference to the database object this control is tied to.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::EdgeAttributeControl