SphereAttributeKit

class HPS::SphereAttributeKit : public HPS::Kit 

The HPS::SphereAttributeKit class is a user space object, useful for carrying a group attribute settings. Calling HPS::SphereAttributeKit::GetDefault() will return a kit with values found in this table.

Public Functions

virtual bool Empty() const

Indicates whether this object has any values set on it.

Returns: true if no values are set on this object, false otherwise.

bool Equals(SphereAttributeKit const &in_kit) const

Check if the source SphereAttributeKit is equivalent to this object.

Parameters: in_kit – The source SphereAttributeKit to compare to this object.
Returns: true if the objects are equivalent, false otherwise.

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.

bool operator!=(SphereAttributeKit const &in_kit) const

Check if the source SphereAttributeKit is not equivalent to this object.

Parameters: in_kit – The source SphereAttributeKit to compare to this object.
Returns: true if the objects are not equivalent, false otherwise.

SphereAttributeKit &operator=(SphereAttributeKit &&in_that)

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

Parameters: in_that – An rvalue reference to a SphereAttributeKit to take the impl from.
Returns: A reference to this SphereAttributeKit.

SphereAttributeKit &operator=(SphereAttributeKit const &in_kit)

Copies the source SphereAttributeKit into this object.

Parameters: in_kit – The source SphereAttributeKit to copy.
Returns: A reference to this object.

bool operator==(SphereAttributeKit const &in_kit) const

Check if the source SphereAttributeKit is equivalent to this object.

Parameters: in_kit – The source SphereAttributeKit to compare to this object.
Returns: true if the objects are equivalent, false otherwise.

void Set(SphereAttributeKit const &in_kit)

Copies all settings from the source SphereAttributeKit into this object.

Parameters: in_kit – The source SphereAttributeKit to copy.

SphereAttributeKit &SetTessellation(size_t in_facets)

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

Parameters: in_facets – the number of faces that should be generated around the equator of spheres.
Returns: A reference to this object.

void Show(SphereAttributeKit &out_kit) const

Copies all settings from this SphereAttributeKit into the given SphereAttributeKit.

Parameters: out_kit – The SphereAttributeKit to populate with the contents of 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.

SphereAttributeKit(): Initializes an empty kit.

SphereAttributeKit(SphereAttributeKit &&in_that)

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

Parameters: in_that – An rvalue reference to a SphereAttributeKit to take the impl from.

SphereAttributeKit(SphereAttributeKit const &in_kit)

The copy constructor creates a new SphereAttributeKit object that contains the same settings as the source object.

Parameters: in_kit – The source object to copy.

SphereAttributeKit &UnsetEverything()

Removes all settings from this object.

Returns: A reference to this object.

SphereAttributeKit &UnsetTessellation()

Removes the sphere tessellation setting.

Returns: A reference to this object.

virtual ~SphereAttributeKit(): Destroy this kit.

Public Static Functions

static SphereAttributeKit GetDefault()

Creates a SphereAttributeKit 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 SphereAttributeKit with the default settings.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::SphereAttributeKit