HPS::CylinderAttributeControl Class Reference

#include <hps.h>

Inheritance diagram for HPS::CylinderAttributeControl:
HPS::Control HPS::Object

Public Member Functions

 CylinderAttributeControl (SegmentKey &in_seg)
 
 CylinderAttributeControl (CylinderAttributeControl const &in_that)
 
 CylinderAttributeControl (CylinderAttributeControl &&in_that)
 
HPS::Type ObjectType () const
 
CylinderAttributeControloperator= (CylinderAttributeControl &&in_that)
 
CylinderAttributeControloperator= (CylinderAttributeControl const &in_that)
 
CylinderAttributeControlSetOrientation (Cylinder::Orientation in_orientation)
 
CylinderAttributeControlSetTessellation (size_t in_facets)
 
bool ShowOrientation (Cylinder::Orientation &out_adjust) const
 
bool ShowTessellation (size_t &out_facets) const
 
virtual HPS::Type Type () const
 
CylinderAttributeControlUnsetEverything ()
 
CylinderAttributeControlUnsetOrientation ()
 
CylinderAttributeControlUnsetTessellation ()
 
 ~CylinderAttributeControl ()
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
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 Attributes

static const HPS::Type staticType = HPS::Type::CylinderAttributeControl
 
- Static Public Attributes inherited from HPS::Control
static const HPS::Type staticType = HPS::Type::Control
 
- 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::Control
 Control (Control &&in_that)
 
Controloperator= (Control &&in_that)
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ CylinderAttributeControl() [1/3]

HPS::CylinderAttributeControl::CylinderAttributeControl ( SegmentKey in_seg)
explicit

Initializes a control tied to the segment in_seg.

◆ CylinderAttributeControl() [2/3]

HPS::CylinderAttributeControl::CylinderAttributeControl ( CylinderAttributeControl const &  in_that)

Initializes a control tied to the same object as in_that.

◆ CylinderAttributeControl() [3/3]

HPS::CylinderAttributeControl::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_thatAn rvalue reference to a CylinderAttributeControl to take the impl from.

◆ ~CylinderAttributeControl()

HPS::CylinderAttributeControl::~CylinderAttributeControl ( )

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

Member Function Documentation

◆ ObjectType()

HPS::Type HPS::CylinderAttributeControl::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::Control.

◆ operator=() [1/2]

CylinderAttributeControl& HPS::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_thatAn rvalue reference to a CylinderAttributeControl to take the impl from.
Returns
A reference to this CylinderAttributeControl.

◆ operator=() [2/2]

CylinderAttributeControl& HPS::CylinderAttributeControl::operator= ( CylinderAttributeControl const &  in_that)

Share the underlying smart-pointer of the CylinderAttributeControl source.

Parameters
in_thatThe CylinderAttributeControl source of the assignment.
Returns
A reference to this CylinderAttributeControl.

◆ SetOrientation()

CylinderAttributeControl& HPS::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_orientationThe orientation of colors and radii of cylinders.
Returns
A reference to this object.

◆ SetTessellation()

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

◆ ShowOrientation()

bool HPS::CylinderAttributeControl::ShowOrientation ( Cylinder::Orientation out_adjust) 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::CylinderAttributeControl::ShowTessellation ( size_t &  out_facets) const

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

Parameters
out_facetsWhether text should be bold.
Returns
true if the setting is valid, false otherwise.

◆ Type()

virtual HPS::Type HPS::CylinderAttributeControl::Type ( ) const
inlinevirtual

This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types.

Warning
This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
Returns
The true type of the object in question.

Reimplemented from HPS::Control.

◆ UnsetEverything()

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

◆ UnsetOrientation()

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

◆ UnsetTessellation()

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

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