The HPS::CylinderAttributeKit class is a user space object, useful for carrying a group attribute settings. More...

#include <hps.h>

Inheritance diagram for HPS::CylinderAttributeKit:

Collaboration diagram for HPS::CylinderAttributeKit:

Public Member Functions
	CylinderAttributeKit ()
	Initializes an empty kit. More...

	CylinderAttributeKit (CylinderAttributeKit const &in_kit)
	The copy constructor creates a new CylinderAttributeKit object that contains the same settings as the source object. More...

	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. More...

CylinderAttributeKit &	operator= (CylinderAttributeKit &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this CylinderAttributeKit thereby avoiding a copy. More...

virtual	~CylinderAttributeKit ()
	Destroy this kit. More...

HPS::Type	ObjectType () const

void	Set (CylinderAttributeKit const &in_kit)
	Copies all settings from the source CylinderAttributeKit into this object. More...

void	Show (CylinderAttributeKit &out_kit) const
	Copies all settings from this CylinderAttributeKit into the given CylinderAttributeKit. More...

CylinderAttributeKit &	operator= (CylinderAttributeKit const &in_kit)
	Copies the source CylinderAttributeKit into this object. More...

bool	Empty () const
	Indicates whether this object has any values set on it. More...

bool	Equals (CylinderAttributeKit const &in_kit) const
	Check if the source CylinderAttributeKit is equivalent to this object. More...

bool	operator== (CylinderAttributeKit const &in_kit) const
	Check if the source CylinderAttributeKit is equivalent to this object. More...

bool	operator!= (CylinderAttributeKit const &in_kit) const
	Check if the source CylinderAttributeKit is not equivalent to this object. More...

CylinderAttributeKit &	SetTessellation (size_t in_facets)
	Sets the number of faces that should be generated around cylinders. More...

CylinderAttributeKit &	SetOrientation (Cylinder::Orientation in_adjust)
	Sets the orientation of colors and radii of cylinders. More...

CylinderAttributeKit &	UnsetTessellation ()
	Removes the cylinder tessellation setting. More...

CylinderAttributeKit &	UnsetOrientation ()
	Removes the cylinder orientation setting. More...

CylinderAttributeKit &	UnsetEverything ()
	Removes all settings from this object. More...

bool	ShowTessellation (size_t &out_facets) const
	Shows the number of faces that should be generated around cylinders. More...

bool	ShowOrientation (Cylinder::Orientation &out_orientation) const
	Shows the orientation of colors and radii of cylinders. More...

virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...

virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...

bool	HasType (HPS::Type in_mask) const
	This function indicates whether this Object has the given Type mask. More...

intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...

intptr_t	GetInstanceID () const
	Returns an identifier that can be used to identify which instance of a class an object is. More...

Static Public Member Functions
static CylinderAttributeKit	GetDefault ()
	Creates a CylinderAttributeKit which contains the default settings. More...

template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::CylinderAttributeKit

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

◆ ~CylinderAttributeKit()

virtual HPS::CylinderAttributeKit::~CylinderAttributeKit ( )

virtual

Destroy this kit.

Member Function Documentation

◆ ClassID()

template<typename T >

static intptr_t HPS::Object::ClassID ( )

inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

◆ 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_kit The source CylinderAttributeKit to compare to this object.

Returns: true if the objects are equivalent, false otherwise.

◆ GetClassID()

intptr_t HPS::Object::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns: A unique value shared by all objects of the same class.

◆ 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.

◆ GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const

inherited

Returns an identifier that can be used to identify which instance of a class an object is.

Different keys and controls will return the same value if they are backed by the same database resource.

Returns: A value unique to an instance of an object and all objects that are backed by the same database resource.

◆ HasType()

bool HPS::Object::HasType ( HPS::Type in_mask ) const

inherited

This function indicates whether this Object has the given Type mask.

Parameters

in_mask The Type mask to check against this Object.

Returns: true if this Object has the given Type mask, false otherwise.

◆ ObjectType()

HPS::Type HPS::CylinderAttributeKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

bool HPS::CylinderAttributeKit::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.

◆ 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_that An 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_kit The 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_kit The source CylinderAttributeKit to compare to this object.

Returns: true if the objects are equivalent, false otherwise.

◆ Reset()

virtual void HPS::Object::Reset ( )

virtualinherited

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

◆ Set()

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

Copies all settings from the source CylinderAttributeKit into this object.

Parameters

in_kit The 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_orientation The 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_facets the 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_kit The 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_orientation The 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_facets The number of faces that should be generated around cylinders

Returns: true if the setting is valid, false otherwise.

◆ Type()

virtual HPS::Type HPS::Kit::Type ( ) const

inlinevirtualinherited

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.

Returns: The true type of the object in question.

Reimplemented from HPS::Object.

◆ 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.

Member Data Documentation

◆ staticType

const HPS::Type HPS::CylinderAttributeKit::staticType = HPS::Type::CylinderAttributeKit

static

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

hps.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CylinderAttributeKit() [1/3]

◆ CylinderAttributeKit() [2/3]

◆ CylinderAttributeKit() [3/3]

◆ ~CylinderAttributeKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetOrientation()

◆ SetTessellation()

◆ Show()

◆ ShowOrientation()

◆ ShowTessellation()

◆ Type()

◆ UnsetEverything()

◆ UnsetOrientation()

◆ UnsetTessellation()

Member Data Documentation

◆ staticType