#include <hps.h>

Public Member Functions | |
HPS::Type | ObjectType () const |
ShapeDefinition & | operator= (ShapeDefinition const &in_that) |
ShapeDefinition & | operator= (ShapeDefinition &&in_that) |
void | Set (ShapeKit const &in_kit) |
ShapeDefinition () | |
ShapeDefinition (Definition const &in_that) | |
ShapeDefinition (ShapeDefinition const &in_that) | |
ShapeDefinition (ShapeDefinition &&in_that) | |
void | Show (ShapeKit &out_kit) const |
![]() | |
virtual void | Assign (Definition const &in_that) |
Definition () | |
Definition (Definition const &in_that) | |
Definition (Definition &&in_that) | |
bool | Equals (Definition const &in_that) const |
UTF8 | Name () const |
bool | operator!= (Definition const &in_that) const |
Definition & | operator= (Definition const &in_that) |
Definition & | operator= (Definition &&in_that) |
bool | operator== (Definition const &in_that) const |
PortfolioKey | Owner () const |
void | Undefine () |
![]() | |
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) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
HPS::Type | Type () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Detailed Description
The ShapeDefinition class is a smart pointer to a database object. It is a handle to a shape defined within a portfolio.
Constructor & Destructor Documentation
HPS::ShapeDefinition::ShapeDefinition | ( | ) |
The default constructor creates an uninitialized ShapeDefinition object. The Type() function will return Type::None.
HPS::ShapeDefinition::ShapeDefinition | ( | Definition const & | in_that | ) |
This constructor creates a ShapeDefinition object that shares the underlying smart-pointer of the source Definition. The copy will only be successful if the source definition is really an upcast of a shader definition. Otherwise the copy will fail and the resulting ShapeDefinition will be invalid.
- Parameters
-
in_that The source Definition to copy.
HPS::ShapeDefinition::ShapeDefinition | ( | ShapeDefinition const & | in_that | ) |
The copy constructor creates a ShapeDefinition object that shares the underlying smart-pointer of the source ShapeDefinition.
- Parameters
-
in_that The source ShapeDefinition to copy.
HPS::ShapeDefinition::ShapeDefinition | ( | ShapeDefinition && | in_that | ) |
The move constructor creates a ShapeDefinition by transferring the underlying impl of the rvalue reference to this ShapeDefinition thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to a ShapeDefinition to take the impl from.
Member Function Documentation
|
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::Definition.
ShapeDefinition& HPS::ShapeDefinition::operator= | ( | ShapeDefinition const & | in_that | ) |
Associate this ShapeDefinition with the same underlying impl as the source ShapeDefinition.
- Parameters
-
in_that The source ShapeDefinition for the assignment.
- Returns
- A reference to this ShapeDefinition.
ShapeDefinition& HPS::ShapeDefinition::operator= | ( | ShapeDefinition && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this ShapeDefinition thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to a ShapeDefinition to take the impl from.
- Returns
- A reference to this ShapeDefinition.
void HPS::ShapeDefinition::Set | ( | ShapeKit const & | in_kit | ) |
Redefine the shape for this ShapeDefinition.
- Parameters
-
in_kit The new shader for this ShapeDefinition.
void HPS::ShapeDefinition::Show | ( | ShapeKit & | out_kit | ) | const |
Shows the shape for this ShapeDefinition.
- Parameters
-
out_kit The shape for this ShapeDefinition.
The documentation for this class was generated from the following file:
- include/hps.h