< Home

< Table of Contents

REFERENCE MANUAL

CylinderAttributeControl Class Reference

#include <hps.h>

Inheritance diagram for CylinderAttributeControl:
Control Object

Public Member Functions

 CylinderAttributeControl (SegmentKey &in_seg)
 
 CylinderAttributeControl (CylinderAttributeControl const &in_that)
 
 CylinderAttributeControl (CylinderAttributeControl &&in_that)
 
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
 
CylinderAttributeControlUnsetEverything ()
 
CylinderAttributeControlUnsetOrientation ()
 
CylinderAttributeControlUnsetTessellation ()
 
 ~CylinderAttributeControl ()
 
- Public Member Functions inherited from Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (Type in_mask) const
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
Type Type () const
 

Additional Inherited Members

- Static Public Member Functions inherited from Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Member Functions inherited from Control
 Control (Control &&in_that)
 
Controloperator= (Control &&in_that)
 

Detailed Description

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

Constructor & Destructor Documentation

CylinderAttributeControl::CylinderAttributeControl ( SegmentKey in_seg)
explicit

Initializes a control tied to the segment in_seg.

CylinderAttributeControl::CylinderAttributeControl ( CylinderAttributeControl const &  in_that)

Initializes a control tied to the same object as in_that.

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::~CylinderAttributeControl ( )

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

Member Function Documentation

Type CylinderAttributeControl::ObjectType ( ) const
inlinevirtual

This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from Control.

CylinderAttributeControl& 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.
CylinderAttributeControl& CylinderAttributeControl::operator= ( CylinderAttributeControl const &  in_that)

Share the smart-pointer.

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

Removes all settings from this object.

Returns
A reference to this object.
CylinderAttributeControl& CylinderAttributeControl::UnsetOrientation ( )

Removes the cylinder orientation setting.

Returns
A reference to this object.
CylinderAttributeControl& CylinderAttributeControl::UnsetTessellation ( )

Removes the cylinder tessellation setting.

Returns
A reference to this object.

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