#include <hps.h>

Inheritance diagram for HPS::LineAttributeKit:
HPS::Kit HPS::Object

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
 
LineAttributeKitoperator= (LineAttributeKit &&in_that)
 
LineAttributeKitoperator= (LineAttributeKit const &in_kit)
 
bool operator== (LineAttributeKit const &in_kit) const
 
void Set (LineAttributeKit const &in_kit)
 
LineAttributeKitSetPattern (char const *in_name)
 
LineAttributeKitSetPattern (char const *in_name, LinePatternOptionsKit const &in_options)
 
LineAttributeKitSetWeight (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
 
LineAttributeKitUnsetEverything ()
 
LineAttributeKitUnsetPattern ()
 
LineAttributeKitUnsetWeight ()
 
virtual ~LineAttributeKit ()
 
- Public Member Functions inherited from HPS::Kit
virtual HPS::Type Type () const
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Member Functions

static LineAttributeKit GetDefault ()
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::LineAttributeKit
 
- Static Public Attributes inherited from HPS::Kit
static const HPS::Type staticType = HPS::Type::Kit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (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

◆ LineAttributeKit() [1/3]

HPS::LineAttributeKit::LineAttributeKit ( )

Initializes an empty kit.

◆ LineAttributeKit() [2/3]

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_kitThe source object to copy.

◆ LineAttributeKit() [3/3]

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_thatAn rvalue reference to a LineAttributeKit to take the impl from.

◆ ~LineAttributeKit()

virtual HPS::LineAttributeKit::~LineAttributeKit ( )
virtual

Destroy this kit.

Member Function Documentation

◆ Empty()

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.

◆ Equals()

bool HPS::LineAttributeKit::Equals ( LineAttributeKit const &  in_kit) const

Check if the source LineAttributeKit is equivalent to this object.

Parameters
in_kitThe source LineAttributeKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static LineAttributeKit HPS::LineAttributeKit::GetDefault ( )
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.

◆ ObjectType()

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.

◆ operator!=()

bool HPS::LineAttributeKit::operator!= ( LineAttributeKit const &  in_kit) const

Check if the source LineAttributeKit is not equivalent to this object.

Parameters
in_kitThe source LineAttributeKit to compare to this object.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

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_thatAn rvalue reference to an LineAttributeKit to take the impl from.
Returns
A reference to this LineAttributeKit.

◆ operator=() [2/2]

LineAttributeKit& HPS::LineAttributeKit::operator= ( LineAttributeKit const &  in_kit)

Copies the source LineAttributeKit into this object.

Parameters
in_kitThe source LineAttributeKit to copy.
Returns
A reference to this object.

◆ operator==()

bool HPS::LineAttributeKit::operator== ( LineAttributeKit const &  in_kit) const

Check if the source LineAttributeKit is equivalent to this object.

Parameters
in_kitThe source LineAttributeKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

void HPS::LineAttributeKit::Set ( LineAttributeKit const &  in_kit)

Copies all settings from the source LineAttributeKit into this object.

Parameters
in_kitThe source LineAttributeKit to copy.

◆ SetPattern() [1/2]

LineAttributeKit& HPS::LineAttributeKit::SetPattern ( char const *  in_name)

Specifies the pattern of lines.

Parameters
in_nameThe name of a line pattern, defined in a portfolio that is accessible.
Returns
A reference to this object.
See also
Programming Guide: Line Patterns

◆ SetPattern() [2/2]

LineAttributeKit& HPS::LineAttributeKit::SetPattern ( char const *  in_name,
LinePatternOptionsKit const &  in_options 
)

Specifies the pattern of lines.

Parameters
in_nameThe name of a line pattern, defined in a portfolio that is accessible.
in_optionsA set of options that modify how the named line pattern is applied.
Returns
A reference to this object.
See also
Programming Guide: Line Patterns

◆ SetWeight()

LineAttributeKit& HPS::LineAttributeKit::SetWeight ( float  in_weight,
Line::SizeUnits  in_units = Line::SizeUnits::ScaleFactor 
)

Sets the weight of lines.

Parameters
in_weightThe weight value for lines.
in_unitsThe units applied to in_weight.
Returns
A reference to this object.

◆ Show()

void HPS::LineAttributeKit::Show ( LineAttributeKit out_kit) const

Copies all settings from this LineAttributeKit into the given LineAttributeKit.

Parameters
out_kitThe LineAttributeKit to populate with the contents of this object.

◆ ShowPattern()

bool HPS::LineAttributeKit::ShowPattern ( UTF8 out_pattern,
LinePatternOptionsKit out_options 
) const

Shows the pattern used to draw lines.

Parameters
out_patternThe name of a line pattern, defined in a portfolio that is accessible.
out_optionsA set of options that modify how the named line pattern is applied.
Returns
true if the setting is valid, false otherwise.

◆ ShowWeight()

bool HPS::LineAttributeKit::ShowWeight ( float &  out_weight,
Line::SizeUnits out_units 
) const

Shows the weight of lines.

Parameters
out_weightThe weight value for lines.
out_unitsThe units applied to in_weight.
Returns
true if the setting is valid, false otherwise.

◆ UnsetEverything()

LineAttributeKit& HPS::LineAttributeKit::UnsetEverything ( )

Removes all settings from this object.

Returns
A reference to this object.

◆ UnsetPattern()

LineAttributeKit& HPS::LineAttributeKit::UnsetPattern ( )

Removes the line pattern setting for lines.

Returns
A reference to this object.

◆ UnsetWeight()

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: