#include <hps.h>
|
static const HPS::Type | staticType = HPS::Type::CylinderAttributeKit |
|
static const HPS::Type | staticType = HPS::Type::Kit |
|
static const HPS::Type | staticType = HPS::Type::None |
|
The HPS::CylinderAttributeKit class is a user space object, useful for carrying a group attribute settings. Calling HPS::CylinderAttributeKit::GetDefault() will return a kit with values found in this table.
HPS::CylinderAttributeKit::CylinderAttributeKit |
( |
| ) |
|
Initializes an empty kit.
The copy constructor creates a new CylinderAttributeKit object that contains the same settings as the source object.
- Parameters
-
in_kit | The source object to copy. |
virtual HPS::CylinderAttributeKit::~CylinderAttributeKit |
( |
| ) |
|
|
virtual |
bool HPS::CylinderAttributeKit::Empty |
( |
| ) |
const |
|
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.
Check if the source CylinderAttributeKit is equivalent to this object.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
Creates a CylinderAttributeKit 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 CylinderAttributeKit with the default settings.
HPS::Type HPS::CylinderAttributeKit::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::Kit.
Check if the source CylinderAttributeKit is not equivalent to this object.
- Parameters
-
- Returns
- true if the objects are not equivalent, false otherwise.
Copies the source CylinderAttributeKit into this object.
- Parameters
-
- Returns
- A reference to this object.
Check if the source CylinderAttributeKit is equivalent to this object.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
Sets the orientation of colors and radii of cylinders. This can be used to invert the order of the radii and/or colors of all cylinders in a segment without editing each one.
- Parameters
-
in_orientation | The orientation of colors and radii of cylinders. |
- Returns
- A reference to this object.
Sets the number of faces that should be generated around cylinders.
- Parameters
-
in_facets | the number of faces that should be generated around cylinders. |
- Returns
- A reference to this object.
Shows the orientation of colors and radii of cylinders.
- Parameters
-
out_orientation | The orientation of colors and radii of cylinders. |
- Returns
- true if the setting is valid, false otherwise.
bool HPS::CylinderAttributeKit::ShowTessellation |
( |
size_t & |
out_facets | ) |
const |
Shows the number of faces that should be generated around cylinders.
- Parameters
-
out_facets | The number of faces that should be generated around cylinders |
- Returns
- true if the setting is valid, false otherwise.
Removes all settings from this object.
- Returns
- A reference to this object.
Removes the cylinder orientation setting.
- Returns
- A reference to this object.
Removes the cylinder tessellation setting.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file: