#include <hps.h>

Public Member Functions | |
bool | Empty () const |
bool | Equals (LineAttributeKit const &in_kit) const |
LineAttributeKit () | |
LineAttributeKit (LineAttributeKit const &in_kit) | |
LineAttributeKit (LineAttributeKit &&in_that) | |
HPS::Type | ObjectType () const |
bool | operator!= (LineAttributeKit const &in_kit) const |
LineAttributeKit & | operator= (LineAttributeKit &&in_that) |
LineAttributeKit & | operator= (LineAttributeKit const &in_kit) |
bool | operator== (LineAttributeKit const &in_kit) const |
void | Set (LineAttributeKit const &in_kit) |
LineAttributeKit & | SetPattern (char const *in_name) |
LineAttributeKit & | SetPattern (char const *in_name, LinePatternOptionsKit const &in_options) |
LineAttributeKit & | SetWeight (float in_weight, Line::SizeUnits in_units=Line::SizeUnits::ScaleFactor) |
void | Show (LineAttributeKit &out_kit) const |
bool | ShowPattern (UTF8 &out_pattern, LinePatternOptionsKit &out_options) const |
bool | ShowWeight (float &out_weight, Line::SizeUnits &out_units) const |
LineAttributeKit & | UnsetEverything () |
LineAttributeKit & | UnsetPattern () |
LineAttributeKit & | UnsetWeight () |
virtual | ~LineAttributeKit () |
![]() | |
virtual HPS::Type | Type () const |
![]() | |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (HPS::Type in_mask) const |
Object (Object const &that) | |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
Static Public Member Functions | |
static LineAttributeKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::LineAttributeKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::Kit |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
Kit (Kit &&in_that) | |
Kit & | operator= (Kit &&in_that) |
Detailed Description
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.
Constructor & Destructor Documentation
HPS::LineAttributeKit::LineAttributeKit | ( | ) |
Initializes an empty kit.
HPS::LineAttributeKit::LineAttributeKit | ( | LineAttributeKit const & | in_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.
HPS::LineAttributeKit::LineAttributeKit | ( | LineAttributeKit && | in_that | ) |
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
-
in_that An rvalue reference to a LineAttributeKit to take the impl from.
|
virtual |
Destroy this kit.
Member Function Documentation
|
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.
bool HPS::LineAttributeKit::Equals | ( | LineAttributeKit const & | in_kit | ) | const |
Check if the source LineAttributeKit is equivalent to this object.
- Parameters
-
in_kit The source LineAttributeKit to compare to this object.
- Returns
- true if the objects are equivalent, false otherwise.
|
static |
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.
bool HPS::LineAttributeKit::operator!= | ( | LineAttributeKit const & | in_kit | ) | const |
Check if the source LineAttributeKit is not equivalent to this object.
- Parameters
-
in_kit The source LineAttributeKit to compare to this object.
- Returns
- true if the objects are not equivalent, false otherwise.
LineAttributeKit& HPS::LineAttributeKit::operator= | ( | LineAttributeKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this LineAttributeKit thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to an LineAttributeKit to take the impl from.
- Returns
- A reference to this LineAttributeKit.
LineAttributeKit& HPS::LineAttributeKit::operator= | ( | LineAttributeKit const & | in_kit | ) |
Copies the source LineAttributeKit into this object.
- Parameters
-
in_kit The source LineAttributeKit to copy.
- Returns
- A reference to this object.
bool HPS::LineAttributeKit::operator== | ( | LineAttributeKit const & | in_kit | ) | const |
Check if the source LineAttributeKit is equivalent to this object.
- Parameters
-
in_kit The source LineAttributeKit to compare to this object.
- Returns
- true if the objects are equivalent, false otherwise.
void HPS::LineAttributeKit::Set | ( | LineAttributeKit const & | in_kit | ) |
Copies all settings from the source LineAttributeKit into this object.
- Parameters
-
in_kit The source LineAttributeKit to copy.
LineAttributeKit& HPS::LineAttributeKit::SetPattern | ( | char const * | in_name | ) |
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
LineAttributeKit& HPS::LineAttributeKit::SetPattern | ( | char const * | in_name, |
LinePatternOptionsKit const & | in_options | ||
) |
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
LineAttributeKit& HPS::LineAttributeKit::SetWeight | ( | float | in_weight, |
Line::SizeUnits | in_units = Line::SizeUnits::ScaleFactor |
||
) |
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.
void HPS::LineAttributeKit::Show | ( | LineAttributeKit & | out_kit | ) | const |
Copies all settings from this LineAttributeKit into the given LineAttributeKit.
- Parameters
-
out_kit The LineAttributeKit to populate with the contents of this object.
bool HPS::LineAttributeKit::ShowPattern | ( | UTF8 & | out_pattern, |
LinePatternOptionsKit & | out_options | ||
) | const |
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.
LineAttributeKit& HPS::LineAttributeKit::UnsetEverything | ( | ) |
Removes all settings from this object.
- Returns
- A reference to this object.
LineAttributeKit& HPS::LineAttributeKit::UnsetPattern | ( | ) |
Removes the line pattern setting for lines.
- Returns
- A reference to this object.
LineAttributeKit& HPS::LineAttributeKit::UnsetWeight | ( | ) |
Removes the weight setting for lines.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- include/hps.h