#include <hps.h>

Inheritance diagram for HPS::CylinderAttributeKit:
HPS::Kit HPS::Object

Public Member Functions

 CylinderAttributeKit ()
 
 CylinderAttributeKit (CylinderAttributeKit const &in_kit)
 
 CylinderAttributeKit (CylinderAttributeKit &&in_that)
 
bool Empty () const
 
bool Equals (CylinderAttributeKit const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (CylinderAttributeKit const &in_kit) const
 
CylinderAttributeKitoperator= (CylinderAttributeKit &&in_that)
 
CylinderAttributeKitoperator= (CylinderAttributeKit const &in_kit)
 
bool operator== (CylinderAttributeKit const &in_kit) const
 
void Set (CylinderAttributeKit const &in_kit)
 
CylinderAttributeKitSetOrientation (Cylinder::Orientation in_adjust)
 
CylinderAttributeKitSetTessellation (size_t in_facets)
 
void Show (CylinderAttributeKit &out_kit) const
 
bool ShowOrientation (Cylinder::Orientation &out_orientation) const
 
bool ShowTessellation (size_t &out_facets) const
 
CylinderAttributeKitUnsetEverything ()
 
CylinderAttributeKitUnsetOrientation ()
 
CylinderAttributeKitUnsetTessellation ()
 
virtual ~CylinderAttributeKit ()
 
- 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 CylinderAttributeKit 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::CylinderAttributeKit
 
- 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::CylinderAttributeKit class is a user space object, useful for carrying a group attribute settings. Calling HPS::CylinderAttributeKit::GetDefault() will return a kit with values found in this table.

Constructor & Destructor Documentation

◆ CylinderAttributeKit() [1/3]

HPS::CylinderAttributeKit::CylinderAttributeKit ( )

Initializes an empty kit.

◆ CylinderAttributeKit() [2/3]

HPS::CylinderAttributeKit::CylinderAttributeKit ( CylinderAttributeKit const &  in_kit)

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

Parameters
in_kitThe source object to copy.

◆ CylinderAttributeKit() [3/3]

HPS::CylinderAttributeKit::CylinderAttributeKit ( CylinderAttributeKit &&  in_that)

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

Parameters
in_thatAn rvalue reference to a CylinderAttributeKit to take the impl from.

◆ ~CylinderAttributeKit()

virtual HPS::CylinderAttributeKit::~CylinderAttributeKit ( )
virtual

Destroy this kit.

Member Function Documentation

◆ Empty()

bool HPS::CylinderAttributeKit::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::CylinderAttributeKit::Equals ( CylinderAttributeKit const &  in_kit) const

Check if the source CylinderAttributeKit is equivalent to this object.

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

◆ GetDefault()

static CylinderAttributeKit HPS::CylinderAttributeKit::GetDefault ( )
static

Creates a CylinderAttributeKit 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 CylinderAttributeKit with the default settings.

◆ ObjectType()

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

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

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

◆ operator=() [1/2]

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

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

Parameters
in_thatAn rvalue reference to a CylinderAttributeKit to take the impl from.
Returns
A reference to this CylinderAttributeKit.

◆ operator=() [2/2]

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

Copies the source CylinderAttributeKit into this object.

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

◆ operator==()

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

Check if the source CylinderAttributeKit is equivalent to this object.

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

◆ Set()

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

Copies all settings from the source CylinderAttributeKit into this object.

Parameters
in_kitThe source CylinderAttributeKit to copy.

◆ SetOrientation()

CylinderAttributeKit& HPS::CylinderAttributeKit::SetOrientation ( Cylinder::Orientation  in_adjust)

Sets the orientation of colors and radii of cylinders. This can be used to invert the order of the radii and/or colors of all cylinders in a segment without editing each one.

Parameters
in_orientationThe orientation of colors and radii of cylinders.
Returns
A reference to this object.

◆ SetTessellation()

CylinderAttributeKit& HPS::CylinderAttributeKit::SetTessellation ( size_t  in_facets)

Sets the number of faces that should be generated around cylinders.

Parameters
in_facetsthe number of faces that should be generated around cylinders.
Returns
A reference to this object.

◆ Show()

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

Copies all settings from this CylinderAttributeKit into the given CylinderAttributeKit.

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

◆ ShowOrientation()

bool HPS::CylinderAttributeKit::ShowOrientation ( Cylinder::Orientation out_orientation) const

Shows the orientation of colors and radii of cylinders.

Parameters
out_orientationThe orientation of colors and radii of cylinders.
Returns
true if the setting is valid, false otherwise.

◆ ShowTessellation()

bool HPS::CylinderAttributeKit::ShowTessellation ( size_t &  out_facets) const

Shows the number of faces that should be generated around cylinders.

Parameters
out_facetsThe number of faces that should be generated around cylinders
Returns
true if the setting is valid, false otherwise.

◆ UnsetEverything()

CylinderAttributeKit& HPS::CylinderAttributeKit::UnsetEverything ( )

Removes all settings from this object.

Returns
A reference to this object.

◆ UnsetOrientation()

CylinderAttributeKit& HPS::CylinderAttributeKit::UnsetOrientation ( )

Removes the cylinder orientation setting.

Returns
A reference to this object.

◆ UnsetTessellation()

CylinderAttributeKit& HPS::CylinderAttributeKit::UnsetTessellation ( )

Removes the cylinder tessellation setting.

Returns
A reference to this object.

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