CylinderAttributeControl

class CylinderAttributeControl : public HPS::Control

The HPS::CylinderAttributeControl class is a smart pointer that is tied to a database object. This object is used to manipulate the various cylinder attributes, such as orientation and tessellation. This table lists default values for the various segment attributes accessible from HPS::CylinderAttributeControl.

Public Functions

CylinderAttributeControl(CylinderAttributeControl &&in_that)

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

Parameters:

in_that – An rvalue reference to a CylinderAttributeControl to take the impl from.

CylinderAttributeControl(CylinderAttributeControl const &in_that)

Initializes a control tied to the same object as in_that.

explicit CylinderAttributeControl(SegmentKey &in_seg)

Initializes a control tied to the segment in_seg.

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.

CylinderAttributeControl &operator=(CylinderAttributeControl &&in_that)

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

Parameters:

in_that – An rvalue reference to a CylinderAttributeControl to take the impl from.

Returns:

A reference to this CylinderAttributeControl.

CylinderAttributeControl &operator=(CylinderAttributeControl const &in_that)

Share the underlying smart-pointer of the CylinderAttributeControl source.

Parameters:

in_that – The CylinderAttributeControl source of the assignment.

Returns:

A reference to this CylinderAttributeControl.

CylinderAttributeControl &SetOrientation(Cylinder::Orientation in_orientation)

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.

CylinderAttributeControl &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.

bool ShowOrientation(Cylinder::Orientation &out_adjust) 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 – Whether text should be bold.

Returns:

true if the setting is valid, false otherwise.

CylinderAttributeControl &UnsetEverything()

Removes all settings from this object. If the control is attached to a WindowKey this function restores the default settings of this control as specified by CylinderAttributeKit::GetDefault().

Returns:

A reference to this object.

CylinderAttributeControl &UnsetOrientation()

Removes the cylinder orientation setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CylinderAttributeKit::GetDefault().

Returns:

A reference to this object.

CylinderAttributeControl &UnsetTessellation()

Removes the cylinder tessellation setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CylinderAttributeKit::GetDefault().

Returns:

A reference to this object.

~CylinderAttributeControl()

Releases a reference to the database object this control is tied to.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::CylinderAttributeControl