HPS::LinePatternParallelKit Class Reference

#include <hps.h>

Inheritance diagram for HPS::LinePatternParallelKit:

Public Member Functions
bool	Empty () const
bool	Equals (LinePatternParallelKit const &in_kit) const
	LinePatternParallelKit ()
	LinePatternParallelKit (LinePatternParallelKit const &in_kit)
	LinePatternParallelKit (LinePatternParallelKit &&in_that)
HPS::Type	ObjectType () const
bool	operator!= (LinePatternParallelKit const &in_kit) const
LinePatternParallelKit &	operator= (LinePatternParallelKit &&in_that)
LinePatternParallelKit &	operator= (LinePatternParallelKit const &in_kit)
bool	operator== (LinePatternParallelKit const &in_kit) const
void	Set (LinePatternParallelKit const &in_kit)
LinePatternParallelKit &	SetAbsoluteLength (bool in_state)
LinePatternParallelKit &	SetAbsoluteWeight (bool in_state)
LinePatternParallelKit &	SetBody (LinePatternElementArray const &in_elements)
LinePatternParallelKit &	SetBody (size_t in_count, LinePatternElement const in_elements [])
LinePatternParallelKit &	SetBody (LinePatternElement const &in_element)
LinePatternParallelKit &	SetContinuous (bool in_state)
LinePatternParallelKit &	SetEndCap (GlyphLinePatternElement const &in_end)
LinePatternParallelKit &	SetJoin (GlyphLinePatternElement const &in_join)
LinePatternParallelKit &	SetJustification (LinePattern::Justification in_type)
LinePatternParallelKit &	SetOffset (float in_offset, LinePattern::SizeUnits in_units, bool in_fixed=false)
LinePatternParallelKit &	SetStartCap (GlyphLinePatternElement const &in_start)
LinePatternParallelKit &	SetWeight (float in_weight, LinePattern::SizeUnits in_units, bool in_fixed=false)
void	Show (LinePatternParallelKit &out_kit) const
bool	ShowAbsoluteLength (bool &out_state) const
bool	ShowAbsoluteWeight (bool &out_state) const
bool	ShowBody (LinePatternElementArray &out_elements) const
bool	ShowContinuous (bool &out_state) const
bool	ShowEndCap (GlyphLinePatternElement &out_end) const
bool	ShowJoin (GlyphLinePatternElement &out_join) const
bool	ShowJustification (LinePattern::Justification &out_type) const
bool	ShowOffset (float &out_offset, LinePattern::SizeUnits &out_units, bool &out_fixed) const
bool	ShowStartCap (GlyphLinePatternElement &out_start) const
bool	ShowWeight (float &out_weight, LinePattern::SizeUnits &out_units, bool &out_fixed) const
LinePatternParallelKit &	UnsetAbsoluteLength ()
LinePatternParallelKit &	UnsetAbsoluteWeight ()
LinePatternParallelKit &	UnsetBody ()
LinePatternParallelKit &	UnsetContinuous ()
LinePatternParallelKit &	UnsetEndCap ()
LinePatternParallelKit &	UnsetEverything ()
LinePatternParallelKit &	UnsetJoin ()
LinePatternParallelKit &	UnsetJustification ()
LinePatternParallelKit &	UnsetOffset ()
LinePatternParallelKit &	UnsetStartCap ()
LinePatternParallelKit &	UnsetWeight ()
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)
Object &	operator= (Object const &other_object)
Object &	operator= (Object &&in_that)
virtual void	Reset ()

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::LinePatternParallelKit
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
Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t	ClassID ()
Protected Member Functions inherited from HPS::Kit
	Kit (Kit &&in_that)
Kit &	operator= (Kit &&in_that)

Detailed Description

The LinePatternParallelKit class is a user space object. It is used to define a single parallel within a line pattern.

Constructor & Destructor Documentation

LinePatternParallelKit() [1/3]

HPS::LinePatternParallelKit::LinePatternParallelKit

(

)

The default constructor creates an empty LinePatternParallelKit object.

LinePatternParallelKit() [2/3]

HPS::LinePatternParallelKit::LinePatternParallelKit

(

LinePatternParallelKit const &

in_kit

)

The copy constructor creates a new LinePatternParallelKit object that contains the same settings as the source LinePatternParallelKit.

Parameters

in_kit

The source LinePatternParallelKit to copy.

LinePatternParallelKit() [3/3]

HPS::LinePatternParallelKit::LinePatternParallelKit

(

LinePatternParallelKit &&

in_that

)

The move constructor creates a LinePatternParallelKit by transferring the underlying impl of the rvalue reference to this LinePatternParallelKit thereby avoiding a copy and allocation.

Parameters

in_that

An rvalue reference to a LinePatternParallelKit to take the impl from.

Member Function Documentation

Empty()

bool HPS::LinePatternParallelKit::Empty ( ) const

virtual

Indicates whether this LinePatternParallelKit has any values set on it.

Returns

true if no values are set on this LinePatternParallelKit, false otherwise.

Reimplemented from HPS::Object.

Equals()

bool HPS::LinePatternParallelKit::Equals

(

LinePatternParallelKit const &

in_kit

)

const

Check if the source LinePatternParallelKit is equivalent to this LinePatternParallelKit.

Parameters

in_kit

The source LinePatternParallelKit to compare to this LinePatternParallelKit.

Returns

true if the objects are equivalent, false otherwise.

ObjectType()

HPS::Type HPS::LinePatternParallelKit::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::LinePatternParallelKit::operator!=

(

LinePatternParallelKit const &

in_kit

)

const

Check if the source LinePatternParallelKit is not equivalent to this LinePatternParallelKit.

Parameters

in_kit

The source LinePatternParallelKit to compare to this LinePatternParallelKit.

Returns

true if the objects are not equivalent, false otherwise.

operator=() [1/2]

LinePatternParallelKit& HPS::LinePatternParallelKit::operator=

(

LinePatternParallelKit &&

in_that

)

The move assignment operator transfers the underlying impl of the rvalue reference to this LinePatternParallelKit thereby avoiding a copy.

Parameters

in_that

An rvalue reference to a LinePatternParallelKit to take the impl from.

Returns

A reference to this LinePatternParallelKit.

operator=() [2/2]

LinePatternParallelKit& HPS::LinePatternParallelKit::operator=

(

LinePatternParallelKit const &

in_kit

)

Copies the source LinePatternParallelKit into this LinePatternParallelKit.

Parameters

in_kit

The source LinePatternParallelKit to copy.

Returns

A reference to this LinePatternParallelKit.

operator==()

bool HPS::LinePatternParallelKit::operator==

(

LinePatternParallelKit const &

in_kit

)

const

Check if the source LinePatternParallelKit is equivalent to this LinePatternParallelKit.

Parameters

in_kit

The source LinePatternParallelKit to compare to this LinePatternParallelKit.

Returns

true if the objects are equivalent, false otherwise.

Set()

void HPS::LinePatternParallelKit::Set

(

LinePatternParallelKit const &

in_kit

)

Copies the source LinePatternParallelKit into this LinePatternParallelKit.

Parameters

in_kit

The source LinePatternParallelKit to copy.

SetAbsoluteLength()

LinePatternParallelKit& HPS::LinePatternParallelKit::SetAbsoluteLength

(

bool

in_state

)

Sets a flag indicating whether to prevent scaling line pattern elements whose size is specified in pixels for this LinePatternParallelKit.

Parameters

in_state

Whether to prevent scaling line pattern elements whose size is specified in pixels for this LinePatternParallelKit.

Returns

A reference to this LinePatternParallelKit.

SetAbsoluteWeight()

LinePatternParallelKit& HPS::LinePatternParallelKit::SetAbsoluteWeight

(

bool

in_state

)

Sets a flag indicating whether to prevent scaling line pattern elements whose weight is specified in pixels for this LinePatternParallelKit.

Parameters

in_state

Whether to prevent scaling line pattern elements whose weight is specified in pixels for this LinePatternParallelKit.

Returns

A reference to this LinePatternParallelKit.

SetBody() [1/3]

LinePatternParallelKit& HPS::LinePatternParallelKit::SetBody

(

LinePatternElementArray const &

in_elements

)

Sets the line pattern element array for this LinePatternParallelKit.

Parameters

in_elements

The line pattern element array for this LinePatternParallelKit.

Returns

A reference to this LinePatternParallelKit.

SetBody() [2/3]

LinePatternParallelKit& HPS::LinePatternParallelKit::SetBody	(	size_t	in_count,
		LinePatternElement const	in_elements[]
	)

Sets the line pattern element body for this LinePatternParallelKit.

Parameters

in_count	Size of the following array.
in_elements	The line pattern element body for this LinePatternParallelKit.

Returns

A reference to this LinePatternParallelKit.

SetBody() [3/3]

LinePatternParallelKit& HPS::LinePatternParallelKit::SetBody

(

LinePatternElement const &

in_element

)

Sets the line pattern element body for this LinePatternParallelKit.

Parameters

in_element

The line pattern element body for this LinePatternParallelKit.

Returns

A reference to this LinePatternParallelKit.

SetContinuous()

LinePatternParallelKit& HPS::LinePatternParallelKit::SetContinuous

(

bool

in_state

)

Sets whether to reset the line pattern in each segment for this LinePatternParallelKit.

Parameters

in_state

Whether to reset the line pattern in each segment for this LinePatternParallelKit.

Returns

A reference to this LinePatternParallelKit.

SetEndCap()

LinePatternParallelKit& HPS::LinePatternParallelKit::SetEndCap

(

GlyphLinePatternElement const &

in_end

)

Sets the glyph to draw at the end point for this LinePatternParallelKit.

Parameters

in_end

The glyph to draw at the end point for this LinePatternParallelKit.

Returns

A reference to this LinePatternParallelKit.

SetJoin()

LinePatternParallelKit& HPS::LinePatternParallelKit::SetJoin

(

GlyphLinePatternElement const &

in_join

)

Sets the glyph to draw at all joins for this LinePatternParallelKit.

Parameters

in_join

The glyph to draw at all joins for this LinePatternParallelKit.

Returns

A reference to this LinePatternParallelKit.

SetJustification()

LinePatternParallelKit& HPS::LinePatternParallelKit::SetJustification

(

LinePattern::Justification

in_type

)

Sets how the pattern will fit between the end points for this LinePatternParallelKit.

Parameters

in_type

How the pattern will fit between the end points for this LinePatternParallelKit.

Returns

A reference to this LinePatternParallelKit.

SetOffset()

LinePatternParallelKit& HPS::LinePatternParallelKit::SetOffset	(	float	in_offset,
		LinePattern::SizeUnits	in_units,
		bool	in_fixed = false
	)

Sets the offset above or below the line connecting two points defining a segment for this LinePatternParallelKit.

Parameters

in_offset	The offset above (positive) or below (negative) the line connecting two points defining a segment for this LinePatternParallelKit.
in_units	The units for the offset for this LinePatternParallelKit.
in_fixed	Whether to prevent scaling the offset based on the effective line weight in the segment where this pattern is used. Defaults to false.

Returns

A reference to this LinePatternParallelKit.

SetStartCap()

LinePatternParallelKit& HPS::LinePatternParallelKit::SetStartCap

(

GlyphLinePatternElement const &

in_start

)

Sets the glyph to draw at the start point for this LinePatternParallelKit.

Parameters

in_start

The glyph to draw at the start point for this LinePatternParallelKit.

Returns

A reference to this LinePatternParallelKit.

SetWeight()

LinePatternParallelKit& HPS::LinePatternParallelKit::SetWeight	(	float	in_weight,
		LinePattern::SizeUnits	in_units,
		bool	in_fixed = false
	)

Sets the line weight for this LinePatternParallelKit.

Parameters

in_weight	The line weight for this LinePatternParallelKit.
in_units	The units for the weight for this LinePatternParallelKit.
in_fixed	Whether to override the effective line weight in the segment where this pattern is used. Defaults to false.

Returns

A reference to this LinePatternParallelKit.

Show()

void HPS::LinePatternParallelKit::Show

(

LinePatternParallelKit &

out_kit

)

const

Copies this LinePatternParallelKit into the given LinePatternParallelKit.

Parameters

out_kit

The LinePatternParallelKit to populate with the contents of this LinePatternParallelKit.

ShowAbsoluteLength()

bool HPS::LinePatternParallelKit::ShowAbsoluteLength

(

bool &

out_state

)

const

Shows whether to prevent scaling line pattern elements whose size is specified in pixels for this LinePatternParallelKit.

Parameters

out_state

Whether to prevent scaling line pattern elements whose size is specified in pixels for this LinePatternParallelKit.

Returns

true if an absolute length was set, false otherwise.

ShowAbsoluteWeight()

bool HPS::LinePatternParallelKit::ShowAbsoluteWeight

(

bool &

out_state

)

const

Shows whether to prevent scaling line pattern elements whose weight is specified in pixels for this LinePatternParallelKit.

Parameters

out_state

Whether to prevent scaling line pattern elements whose weight is specified in pixels for this LinePatternParallelKit.

Returns

true if an absolute weight was set, false otherwise.

ShowBody()

bool HPS::LinePatternParallelKit::ShowBody

(

LinePatternElementArray &

out_elements

)

const

Shows the line pattern element body for this LinePatternParallelKit.

Parameters

out_elements

The line pattern element body for this LinePatternParallelKit.

Returns

true if a body was set, false otherwise.

ShowContinuous()

bool HPS::LinePatternParallelKit::ShowContinuous

(

bool &

out_state

)

const

Shows whether to reset the line pattern in each segment for this LinePatternParallelKit.

Parameters

out_state

Whether to reset the line pattern in each segment for this LinePatternParallelKit.

Returns

true if a continuous flag was set, false otherwise.

ShowEndCap()

bool HPS::LinePatternParallelKit::ShowEndCap

(

GlyphLinePatternElement &

out_end

)

const

Shows the glyph to draw at the end point for this LinePatternParallelKit.

Parameters

out_end

The glyph to draw at the end point for this LinePatternParallelKit.

Returns

true if an end cap was set, false otherwise.

ShowJoin()

bool HPS::LinePatternParallelKit::ShowJoin

(

GlyphLinePatternElement &

out_join

)

const

Shows the glyph to draw at all joins for this LinePatternParallelKit.

Parameters

out_join

The glyph to draw at all joins for this LinePatternParallelKit.

Returns

true if a join was set, false otherwise.

ShowJustification()

bool HPS::LinePatternParallelKit::ShowJustification

(

LinePattern::Justification &

out_type

)

const

Shows how the pattern will fit between the end points for this LinePatternParallelKit.

Parameters

out_type

How the pattern will fit between the end points for this LinePatternParallelKit.

Returns

true if a justficiation was set, false otherwise.

ShowOffset()

bool HPS::LinePatternParallelKit::ShowOffset	(	float &	out_offset,
		LinePattern::SizeUnits &	out_units,
		bool &	out_fixed
	)		const

Shows the offset above or below the line connecting two points defining a segment for this LinePatternParallelKit.

Parameters

out_offset	The offset above (positive) or below (negative) the line connecting two points defining a segment for this LinePatternParallelKit.
out_units	The units for the offset for this LinePatternParallelKit.
out_fixed	Whether to prevent scaling the offset based on the effective line weight in the segment where this pattern is used.

Returns

true if an offset is set, false otherwise.

ShowStartCap()

bool HPS::LinePatternParallelKit::ShowStartCap

(

GlyphLinePatternElement &

out_start

)

const

Shows the glyph to draw at the start point for this LinePatternParallelKit.

Parameters

out_start

The glyph to draw at the start point for this LinePatternParallelKit.

Returns

true if a start cap was set, false otherwise.

ShowWeight()

bool HPS::LinePatternParallelKit::ShowWeight	(	float &	out_weight,
		LinePattern::SizeUnits &	out_units,
		bool &	out_fixed
	)		const

Shows the line weight for this LinePatternParallelKit.

Parameters

out_weight	The line weight for this LinePatternParallelKit.
out_units	The units for the weight for this LinePatternParallelKit.
out_fixed	Whether to override the effective line weight in the segment where this pattern is used.

Returns

true if a weight was set, false otherwise.

UnsetAbsoluteLength()

LinePatternParallelKit& HPS::LinePatternParallelKit::UnsetAbsoluteLength

(

)

Removes whether to prevent scaling line pattern elements whose size is specified in pixels for this LinePatternParallelKit.

Returns

A reference to this LinePatternParallelKit.

UnsetAbsoluteWeight()

LinePatternParallelKit& HPS::LinePatternParallelKit::UnsetAbsoluteWeight

(

)

Removes whether to prevent scaling line pattern elements whose weight is specified in pixels for this LinePatternParallelKit.

Returns

A reference to this LinePatternParallelKit.

UnsetBody()

LinePatternParallelKit& HPS::LinePatternParallelKit::UnsetBody

(

)

Removes the line pattern element body for this LinePatternParallelKit.

Returns

A reference to this LinePatternParallelKit.

UnsetContinuous()

LinePatternParallelKit& HPS::LinePatternParallelKit::UnsetContinuous

(

)

Removes whether to reset the line pattern in each segment for this LinePatternParallelKit.

Returns

A reference to this LinePatternParallelKit.

UnsetEndCap()

LinePatternParallelKit& HPS::LinePatternParallelKit::UnsetEndCap

(

)

Removes the glyph to draw at the end point for this LinePatternParallelKit.

Returns

A reference to this LinePatternParallelKit.

UnsetEverything()

LinePatternParallelKit& HPS::LinePatternParallelKit::UnsetEverything

(

)

Removes all settings from this LinePatternParallelKit.

Returns

A reference to this LinePatternParallelKit.

UnsetJoin()

LinePatternParallelKit& HPS::LinePatternParallelKit::UnsetJoin

(

)

Removes the glyph to draw at all joins for this LinePatternParallelKit.

Returns

A reference to this LinePatternParallelKit.

UnsetJustification()

LinePatternParallelKit& HPS::LinePatternParallelKit::UnsetJustification

(

)

Removes how the pattern will fit between the end points for this LinePatternParallelKit.

Returns

A reference to this LinePatternParallelKit.

UnsetOffset()

LinePatternParallelKit& HPS::LinePatternParallelKit::UnsetOffset

(

)

Removes the offset above or below the line connecting two points defining a segment for this LinePatternParallelKit.

Returns

A reference to this LinePatternParallelKit.

UnsetStartCap()

LinePatternParallelKit& HPS::LinePatternParallelKit::UnsetStartCap

(

)

Removes the glyph to draw at the start point for this LinePatternParallelKit.

Returns

A reference to this LinePatternParallelKit.

UnsetWeight()

LinePatternParallelKit& HPS::LinePatternParallelKit::UnsetWeight

(

)

Removes the line weight for this LinePatternParallelKit.

Returns

A reference to this LinePatternParallelKit.

---

The documentation for this class was generated from the following file:

• include/hps.h