#include <hps.h>
|
static const HPS::Type | staticType = HPS::Type::LineAttributeKit |
|
static const HPS::Type | staticType = HPS::Type::Kit |
|
static const HPS::Type | staticType = HPS::Type::None |
|
The HPS::LineAttributeKit class is a user space object, useful for carrying a group of attribute settings related to lines. Calling HPS::LineAttributeKit::GetDefault() will return a kit with values found in this table.
HPS::LineAttributeKit::LineAttributeKit |
( |
| ) |
|
Initializes an empty kit.
The copy constructor creates a new LineAttributeKit object that contains the same settings as the source object.
- Parameters
-
in_kit | The source object to copy. |
The move constructor creates a LineAttributeKit by transferring the underlying impl of the rvalue reference to this LineAttributeKit thereby avoiding a copy and allocation.
- Parameters
-
virtual HPS::LineAttributeKit::~LineAttributeKit |
( |
| ) |
|
|
virtual |
bool HPS::LineAttributeKit::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 LineAttributeKit is equivalent to this object.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
Creates a LineAttributeKit 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 LineAttributeKit with the default settings.
HPS::Type HPS::LineAttributeKit::ObjectType |
( |
| ) |
const |
|
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::Kit.
Check if the source LineAttributeKit 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 LineAttributeKit thereby avoiding a copy.
- Parameters
-
- Returns
- A reference to this LineAttributeKit.
Copies the source LineAttributeKit into this object.
- Parameters
-
- Returns
- A reference to this object.
Check if the source LineAttributeKit is equivalent to this object.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
Copies all settings from the source LineAttributeKit into this object.
- Parameters
-
Specifies the pattern of lines.
- Parameters
-
in_name | 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
Specifies the pattern of lines.
- Parameters
-
in_name | The name of a line pattern, defined in a portfolio that is accessible. |
in_options | A set of options that modify how the named line pattern is applied. |
- Returns
- A reference to this object.
- See also
- Programming Guide: Line Patterns
Sets the weight of lines.
- Parameters
-
in_weight | The weight value for lines. |
in_units | The units applied to in_weight. |
- Returns
- A reference to this object.
Shows the pattern used to draw lines.
- Parameters
-
out_pattern | The name of a line pattern, defined in a portfolio that is accessible. |
out_options | A set of options that modify how the named line pattern is applied. |
- Returns
- true if the setting is valid, false otherwise.
bool HPS::LineAttributeKit::ShowWeight |
( |
float & |
out_weight, |
|
|
Line::SizeUnits & |
out_units |
|
) |
| const |
Shows the weight of lines.
- Parameters
-
out_weight | The weight value for lines. |
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 line pattern setting for lines.
- Returns
- A reference to this object.
Removes the weight setting for lines.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file: