#include <hps.h>

Public Member Functions | |
bool | Empty () const |
bool | Equals (SphereAttributeKit const &in_kit) const |
HPS::Type | ObjectType () const |
bool | operator!= (SphereAttributeKit const &in_kit) const |
SphereAttributeKit & | operator= (SphereAttributeKit &&in_that) |
SphereAttributeKit & | operator= (SphereAttributeKit const &in_kit) |
bool | operator== (SphereAttributeKit const &in_kit) const |
void | Set (SphereAttributeKit const &in_kit) |
SphereAttributeKit & | SetTessellation (size_t in_facets) |
void | Show (SphereAttributeKit &out_kit) const |
bool | ShowTessellation (size_t &out_facets) const |
SphereAttributeKit () | |
SphereAttributeKit (SphereAttributeKit const &in_kit) | |
SphereAttributeKit (SphereAttributeKit &&in_that) | |
SphereAttributeKit & | UnsetEverything () |
SphereAttributeKit & | UnsetTessellation () |
virtual | ~SphereAttributeKit () |
![]() | |
virtual HPS::Type | Type () const |
![]() | |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (HPS::Type in_mask) const |
Object (Object const &that) | |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
Static Public Member Functions | |
static SphereAttributeKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Additional Inherited Members | |
![]() | |
Kit (Kit &&in_that) | |
Kit & | operator= (Kit &&in_that) |
Detailed Description
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.
Constructor & Destructor Documentation
HPS::SphereAttributeKit::SphereAttributeKit | ( | ) |
Initializes an empty kit.
HPS::SphereAttributeKit::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.
HPS::SphereAttributeKit::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.
|
virtual |
Destroy this kit.
Member Function Documentation
|
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.
bool HPS::SphereAttributeKit::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.
|
static |
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.
|
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 HPS::Kit.
bool HPS::SphereAttributeKit::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& HPS::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& HPS::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 HPS::SphereAttributeKit::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 HPS::SphereAttributeKit::Set | ( | SphereAttributeKit const & | in_kit | ) |
Copies all settings from the source SphereAttributeKit into this object.
- Parameters
-
in_kit The source SphereAttributeKit to copy.
SphereAttributeKit& HPS::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 HPS::SphereAttributeKit::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 HPS::SphereAttributeKit::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& HPS::SphereAttributeKit::UnsetEverything | ( | ) |
Removes all settings from this object.
- Returns
- A reference to this object.
SphereAttributeKit& HPS::SphereAttributeKit::UnsetTessellation | ( | ) |
Removes the sphere tessellation setting.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- include/hps.h