HPS::SphereAttributeControl Class Reference

#include <hps.h>

Inheritance diagram for HPS::SphereAttributeControl:
HPS::Control HPS::Object

Public Member Functions

HPS::Type ObjectType () const
 
SphereAttributeControloperator= (SphereAttributeControl &&in_that)
 
SphereAttributeControloperator= (SphereAttributeControl const &in_that)
 
SphereAttributeControlSetTessellation (size_t in_facets)
 
bool ShowTessellation (size_t &out_facets) const
 
 SphereAttributeControl (SegmentKey const &in_seg)
 
 SphereAttributeControl (SphereAttributeControl const &in_that)
 
 SphereAttributeControl (SphereAttributeControl &&in_that)
 
virtual HPS::Type Type () const
 
SphereAttributeControlUnsetEverything ()
 
SphereAttributeControlUnsetTessellation ()
 
 ~SphereAttributeControl ()
 
- 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::SphereAttributeControl
 
- 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::SphereAttributeControl class is a smart pointer that is tied to a database object. This control gives you access to the tessellation value for spheres. This table lists default values for the various segment attributes accessible from HPS::SphereAttributeControl.

Constructor & Destructor Documentation

◆ SphereAttributeControl() [1/3]

HPS::SphereAttributeControl::SphereAttributeControl ( SegmentKey const &  in_seg)
explicit

Initializes a control tied to the segment in_seg.

◆ SphereAttributeControl() [2/3]

HPS::SphereAttributeControl::SphereAttributeControl ( SphereAttributeControl const &  in_that)

Initializes a control tied to the same object as in_that.

◆ SphereAttributeControl() [3/3]

HPS::SphereAttributeControl::SphereAttributeControl ( SphereAttributeControl &&  in_that)

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

Parameters
in_thatAn rvalue reference to a SphereAttributeControl to take the impl from.

◆ ~SphereAttributeControl()

HPS::SphereAttributeControl::~SphereAttributeControl ( )

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

Member Function Documentation

◆ ObjectType()

HPS::Type HPS::SphereAttributeControl::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]

SphereAttributeControl& HPS::SphereAttributeControl::operator= ( SphereAttributeControl &&  in_that)

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

Parameters
in_thatAn rvalue reference to a SphereAttributeControl to take the impl from.
Returns
A reference to this SphereAttributeControl.

◆ operator=() [2/2]

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

Share the underlying smart-pointer of the SphereAttributeControl source.

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

◆ SetTessellation()

SphereAttributeControl& HPS::SphereAttributeControl::SetTessellation ( size_t  in_facets)

Sets the number of faces that should be generated around the equator of spheres.

Parameters
in_facetsthe number of faces that should be generated around the equator of spheres.
Returns
A reference to this object.
See also
Sphere tessellation default value

◆ ShowTessellation()

bool HPS::SphereAttributeControl::ShowTessellation ( size_t &  out_facets) const

Shows the number of faces that should be generated around the equator of spheres.

Parameters
out_facetsThe number of faces that should be generated around the equator of spheres.
Returns
true if the setting is valid, false otherwise.

◆ Type()

virtual HPS::Type HPS::SphereAttributeControl::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()

SphereAttributeControl& HPS::SphereAttributeControl::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 SphereAttributeKit::GetDefault().

Returns
A reference to this object.

◆ UnsetTessellation()

SphereAttributeControl& HPS::SphereAttributeControl::UnsetTessellation ( )

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

Returns
A reference to this object.

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