EdgeAttributeKit
-
class
EdgeAttributeKit: public 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
-
EdgeAttributeKit() Initializes an empty kit.
-
EdgeAttributeKit(EdgeAttributeKit &&in_that) The move constructor creates an EdgeAttributeKit by transferring the underlying impl of the rvalue reference to this EdgeAttributeKit thereby avoiding a copy and allocation.
Parameters: in_that – An rvalue reference to an EdgeAttributeKit to take the impl from.
-
EdgeAttributeKit(EdgeAttributeKit const &in_kit) The copy constructor creates a new EdgeAttributeKit object that contains the same settings as the source object.
Parameters: in_kit – The source object to copy.
-
virtual bool
Empty() const Indicates whether this object has any values set on it.
Returns: true if no values are set on this object, false otherwise.
-
bool
Equals(EdgeAttributeKit const &in_kit) const Check if the source EdgeAttributeKit is equivalent to this object.
Parameters: in_kit – The source EdgeAttributeKit to compare to this object. Returns: true if the objects are equivalent, false otherwise.
-
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.
-
bool
operator!=(EdgeAttributeKit const &in_kit) const Check if the source EdgeAttributeKit is not equivalent to this object.
Parameters: in_kit – The source EdgeAttributeKit to compare to this object. Returns: true if the objects are not equivalent, false otherwise.
-
EdgeAttributeKit &
operator=(EdgeAttributeKit &&in_that) The move assignment operator transfers the underlying impl of the rvalue reference to this EdgeAttributeKit thereby avoiding a copy.
Parameters: in_that – An rvalue reference to an EdgeAttributeKit to take the impl from. Returns: A reference to this EdgeAttributeKit.
-
EdgeAttributeKit &
operator=(EdgeAttributeKit const &in_kit) Copies the source EdgeAttributeKit into this object.
Parameters: in_kit – The source EdgeAttributeKit to copy. Returns: A reference to this object.
-
bool
operator==(EdgeAttributeKit const &in_kit) const Check if the source EdgeAttributeKit is equivalent to this object.
Parameters: in_kit – The source EdgeAttributeKit to compare to this object. Returns: true if the objects are equivalent, false otherwise.
-
void
Set(EdgeAttributeKit const &in_kit) Copies all settings from the source EdgeAttributeKit into this object.
Parameters: in_kit – The source EdgeAttributeKit to copy.
-
EdgeAttributeKit &
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.
-
EdgeAttributeKit &
SetPattern(char const *in_pattern_name) Specifies the pattern of edges.
See also
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.
-
EdgeAttributeKit &
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.
-
void
Show(EdgeAttributeKit &out_kit) const Copies all settings from this EdgeAttributeKit into the given EdgeAttributeKit.
Parameters: out_kit – The EdgeAttributeKit to populate with the contents of 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.
-
EdgeAttributeKit &
UnsetEverything() Removes all settings from this object.
Returns: A reference to this object.
-
EdgeAttributeKit &
UnsetHardAngle() Removes the hard edge angle setting.
Returns: A reference to this object.
-
EdgeAttributeKit &
UnsetPattern() Removes the line pattern setting for edges.
Returns: A reference to this object.
-
EdgeAttributeKit &
UnsetWeight() Removes the weight setting for edges.
Returns: A reference to this object.
-
virtual
~EdgeAttributeKit() Destroy this kit.
Public Static Functions
-
static 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.
Returns: A EdgeAttributeKit with the default settings.
-
