#include <hps.h>
|
static const HPS::Type | staticType = HPS::Type::EdgeAttributeKit |
|
static const HPS::Type | staticType = HPS::Type::Kit |
|
static const HPS::Type | staticType = HPS::Type::None |
|
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.
HPS::EdgeAttributeKit::EdgeAttributeKit |
( |
| ) |
|
Initializes an empty 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. |
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
-
virtual HPS::EdgeAttributeKit::~EdgeAttributeKit |
( |
| ) |
|
|
virtual |
bool HPS::EdgeAttributeKit::Empty |
( |
| ) |
const |
|
virtual |
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.
Check if the source EdgeAttributeKit is equivalent to this object.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
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.
Check if the source EdgeAttributeKit is not equivalent to this object.
- Parameters
-
- Returns
- true if the objects are not equivalent, false otherwise.
The move assignment operator transfers the underlying impl of the rvalue reference to this EdgeAttributeKit thereby avoiding a copy.
- Parameters
-
- Returns
- A reference to this EdgeAttributeKit.
Copies the source EdgeAttributeKit into this object.
- Parameters
-
- Returns
- A reference to this object.
Check if the source EdgeAttributeKit is equivalent to this object.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
Copies all settings from the source EdgeAttributeKit into this object.
- Parameters
-
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& HPS::EdgeAttributeKit::SetPattern |
( |
char const * |
in_pattern_name | ) |
|
Specifies the pattern of edges.
- Parameters
-
in_pattern | The name of a line pattern, defined in a portfolio that is accessible. |
- Returns
- A reference to this object.
- See also
- Programming Guide: Line Patterns
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 HPS::EdgeAttributeKit::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 HPS::EdgeAttributeKit::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 HPS::EdgeAttributeKit::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.
Removes all settings from this object.
- Returns
- A reference to this object.
Removes the hard edge angle setting.
- Returns
- A reference to this object.
Removes the line pattern setting for edges.
- Returns
- A reference to this object.
Removes the weight setting for edges.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file: