CylinderAttributeKit

class HPS::CylinderAttributeKit : public HPS::Kit 

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.

Public Functions

CylinderAttributeKit(): Initializes an empty kit.

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_that – An rvalue reference to a CylinderAttributeKit to take the impl from.

CylinderAttributeKit(CylinderAttributeKit const &in_kit)

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

Parameters: in_kit – The source object to copy.

virtual bool Empty() const

Indicates whether this object has any values set on it.

Returns: true if no values are set on this object, false otherwise.

bool Equals(CylinderAttributeKit const &in_kit) const

Check if the source CylinderAttributeKit is equivalent to this object.

Parameters: in_kit – The source CylinderAttributeKit to compare to this object.
Returns: true if the objects are equivalent, false otherwise.

inline virtual HPS::Type ObjectType() const

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.

bool operator!=(CylinderAttributeKit const &in_kit) const

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

Parameters: in_kit – The source CylinderAttributeKit to compare to this object.
Returns: true if the objects are not equivalent, false otherwise.

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_that – An rvalue reference to a CylinderAttributeKit to take the impl from.
Returns: A reference to this CylinderAttributeKit.

CylinderAttributeKit &operator=(CylinderAttributeKit const &in_kit)

Copies the source CylinderAttributeKit into this object.

Parameters: in_kit – The source CylinderAttributeKit to copy.
Returns: A reference to this object.

bool operator==(CylinderAttributeKit const &in_kit) const

Check if the source CylinderAttributeKit is equivalent to this object.

Parameters: in_kit – The source CylinderAttributeKit to compare to this object.
Returns: true if the objects are equivalent, false otherwise.

void Set(CylinderAttributeKit const &in_kit)

Copies all settings from the source CylinderAttributeKit into this object.

Parameters: in_kit – The source CylinderAttributeKit to copy.

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_orientation – The orientation of colors and radii of cylinders.
Returns: A reference to this object.

CylinderAttributeKit &SetTessellation(size_t in_facets)

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

Parameters: in_facets – the number of faces that should be generated around cylinders.
Returns: A reference to this object.

void Show(CylinderAttributeKit &out_kit) const

Copies all settings from this CylinderAttributeKit into the given CylinderAttributeKit.

Parameters: out_kit – The CylinderAttributeKit to populate with the contents of this object.

bool ShowOrientation(Cylinder::Orientation &out_orientation) const

Shows the orientation of colors and radii of cylinders.

Parameters: out_orientation – The orientation of colors and radii of cylinders.
Returns: true if the setting is valid, false otherwise.

bool ShowTessellation(size_t &out_facets) const

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

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

CylinderAttributeKit &UnsetEverything()

Removes all settings from this object.

Returns: A reference to this object.

CylinderAttributeKit &UnsetOrientation()

Removes the cylinder orientation setting.

Returns: A reference to this object.

CylinderAttributeKit &UnsetTessellation()

Removes the cylinder tessellation setting.

Returns: A reference to this object.

virtual ~CylinderAttributeKit(): Destroy this kit.

Public Static Functions

static CylinderAttributeKit GetDefault()

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.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::CylinderAttributeKit