SphereAttributeControl
-
class HPS::SphereAttributeControl : public HPS::Control
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.
Public Functions
-
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.
-
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_that – An rvalue reference to a SphereAttributeControl to take the impl from.
- Returns
A reference to this SphereAttributeControl.
-
SphereAttributeControl &operator=(SphereAttributeControl const &in_that)
Share the underlying smart-pointer of the SphereAttributeControl source.
- Parameters
in_that – The SphereAttributeControl source of the assignment.
- Returns
A reference to this SphereAttributeControl.
-
SphereAttributeControl &SetTessellation(size_t in_facets)
Sets the number of faces that should be generated around the equator of spheres.
- See
Sphere tessellation default value
- Parameters
in_facets – the number of faces that should be generated around the equator of spheres.
- Returns
A reference to this object.
-
bool ShowTessellation(size_t &out_facets) const
Shows the number of faces that should be generated around the equator of spheres.
- Parameters
out_facets – The number of faces that should be generated around the equator of spheres.
- Returns
true if the setting is valid, false otherwise.
-
explicit SphereAttributeControl(SegmentKey const &in_seg)
Initializes a control tied to the segment in_seg.
-
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_that – An rvalue reference to a SphereAttributeControl to take the impl from.
-
SphereAttributeControl(SphereAttributeControl const &in_that)
Initializes a control tied to the same object as in_that.
-
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.
-
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.
-
~SphereAttributeControl()
Releases a reference to the database object this control is tied to.
Public Static Attributes
-
static const HPS::Type staticType = HPS::Type::SphereAttributeControl
-
inline virtual HPS::Type ObjectType() const
