#include <hps.h>

Inheritance diagram for HPS::EdgeAttributeKit:
HPS::Kit HPS::Object

Public Member Functions

 EdgeAttributeKit ()
 
 EdgeAttributeKit (EdgeAttributeKit const &in_kit)
 
 EdgeAttributeKit (EdgeAttributeKit &&in_that)
 
bool Empty () const
 
bool Equals (EdgeAttributeKit const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (EdgeAttributeKit const &in_kit) const
 
EdgeAttributeKitoperator= (EdgeAttributeKit &&in_that)
 
EdgeAttributeKitoperator= (EdgeAttributeKit const &in_kit)
 
bool operator== (EdgeAttributeKit const &in_kit) const
 
void Set (EdgeAttributeKit const &in_kit)
 
EdgeAttributeKitSetHardAngle (float in_angle)
 
EdgeAttributeKitSetPattern (char const *in_pattern_name)
 
EdgeAttributeKitSetWeight (float in_weight, Edge::SizeUnits in_units=Edge::SizeUnits::ScaleFactor)
 
void Show (EdgeAttributeKit &out_kit) const
 
bool ShowHardAngle (float &out_angle) const
 
bool ShowPattern (UTF8 &out_pattern_name) const
 
bool ShowWeight (float &out_weight, Edge::SizeUnits &out_units) const
 
EdgeAttributeKitUnsetEverything ()
 
EdgeAttributeKitUnsetHardAngle ()
 
EdgeAttributeKitUnsetPattern ()
 
EdgeAttributeKitUnsetWeight ()
 
virtual ~EdgeAttributeKit ()
 
- 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 EdgeAttributeKit 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::EdgeAttributeKit
 
- 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::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.

Constructor & Destructor Documentation

◆ EdgeAttributeKit() [1/3]

HPS::EdgeAttributeKit::EdgeAttributeKit ( )

Initializes an empty kit.

◆ EdgeAttributeKit() [2/3]

HPS::EdgeAttributeKit::EdgeAttributeKit ( EdgeAttributeKit const &  in_kit)

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

Parameters
in_kitThe source object to copy.

◆ EdgeAttributeKit() [3/3]

HPS::EdgeAttributeKit::EdgeAttributeKit ( EdgeAttributeKit &&  in_that)

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
in_thatAn rvalue reference to an EdgeAttributeKit to take the impl from.

◆ ~EdgeAttributeKit()

virtual HPS::EdgeAttributeKit::~EdgeAttributeKit ( )
virtual

Destroy this kit.

Member Function Documentation

◆ Empty()

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.

◆ Equals()

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

Check if the source EdgeAttributeKit is equivalent to this object.

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

◆ GetDefault()

static EdgeAttributeKit HPS::EdgeAttributeKit::GetDefault ( )
static

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.

◆ ObjectType()

HPS::Type HPS::EdgeAttributeKit::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::EdgeAttributeKit::operator!= ( EdgeAttributeKit const &  in_kit) const

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

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

◆ operator=() [1/2]

EdgeAttributeKit& HPS::EdgeAttributeKit::operator= ( EdgeAttributeKit &&  in_that)

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

Parameters
in_thatAn rvalue reference to an EdgeAttributeKit to take the impl from.
Returns
A reference to this EdgeAttributeKit.

◆ operator=() [2/2]

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

Copies the source EdgeAttributeKit into this object.

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

◆ operator==()

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

Check if the source EdgeAttributeKit is equivalent to this object.

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

◆ Set()

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

Copies all settings from the source EdgeAttributeKit into this object.

Parameters
in_kitThe source EdgeAttributeKit to copy.

◆ SetHardAngle()

EdgeAttributeKit& HPS::EdgeAttributeKit::SetHardAngle ( float  in_angle)

Sets the angle between adjacent faces necessary for the edge between them to be considered a hard edge.

Parameters
in_angleThe angle, in degrees, between the adjacent faces necessary for a hard edge.
Returns
A reference to this object.

◆ SetPattern()

EdgeAttributeKit& HPS::EdgeAttributeKit::SetPattern ( char const *  in_pattern_name)

Specifies the pattern of edges.

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

◆ SetWeight()

EdgeAttributeKit& HPS::EdgeAttributeKit::SetWeight ( float  in_weight,
Edge::SizeUnits  in_units = Edge::SizeUnits::ScaleFactor 
)

Sets the weight of lines drawn in edge rendering.

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

◆ Show()

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

Copies all settings from this EdgeAttributeKit into the given EdgeAttributeKit.

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

◆ ShowHardAngle()

bool HPS::EdgeAttributeKit::ShowHardAngle ( float &  out_angle) const

Shows the weight of lines drawn in edge rendering.

Parameters
out_angleThe angle, in degrees, between the adjacent faces necessary for a hard edge.
Returns
true if the setting is valid, false otherwise.

◆ ShowPattern()

bool HPS::EdgeAttributeKit::ShowPattern ( UTF8 out_pattern_name) const

Shows the line pattern of the edges.

Parameters
out_patternThe name of a line pattern, defined in a portfolio that is accessible.
Returns
true if the setting is valid, false otherwise.

◆ ShowWeight()

bool HPS::EdgeAttributeKit::ShowWeight ( float &  out_weight,
Edge::SizeUnits out_units 
) const

Shows the weight of lines drawn in edge rendering.

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

◆ UnsetEverything()

EdgeAttributeKit& HPS::EdgeAttributeKit::UnsetEverything ( )

Removes all settings from this object.

Returns
A reference to this object.

◆ UnsetHardAngle()

EdgeAttributeKit& HPS::EdgeAttributeKit::UnsetHardAngle ( )

Removes the hard edge angle setting.

Returns
A reference to this object.

◆ UnsetPattern()

EdgeAttributeKit& HPS::EdgeAttributeKit::UnsetPattern ( )

Removes the line pattern setting for edges.

Returns
A reference to this object.

◆ UnsetWeight()

EdgeAttributeKit& HPS::EdgeAttributeKit::UnsetWeight ( )

Removes the weight setting for edges.

Returns
A reference to this object.

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