#include <hps.h>

Public Member Functions | |
void | Consume (CylinderKit &in_kit) |
CylinderKit () | |
CylinderKit (CylinderKit const &in_kit) | |
CylinderKit (CylinderKit &&in_that) | |
bool | Empty () const |
bool | Equals (CylinderKit const &in_kit) const |
size_t | GetPointCount () const |
HPS::Type | ObjectType () const |
bool | operator!= (CylinderKit const &in_kit) const |
CylinderKit & | operator= (CylinderKit &&in_that) |
CylinderKit & | operator= (CylinderKit const &in_kit) |
bool | operator== (CylinderKit const &in_kit) const |
void | Set (CylinderKit const &in_kit) |
CylinderKit & | SetCaps (Cylinder::Capping in_capping) |
CylinderKit & | SetPoints (PointArray const &in_points) |
CylinderKit & | SetPoints (size_t in_count, Point const in_points []) |
CylinderKit & | SetPriority (int in_priority) |
CylinderKit & | SetRadii (FloatArray const &in_radii) |
CylinderKit & | SetRadii (size_t in_count, float const in_radii []) |
CylinderKit & | SetUserData (intptr_t in_index, size_t in_bytes, byte const in_data[]) |
CylinderKit & | SetUserData (intptr_t in_index, ByteArray const &in_data) |
CylinderKit & | SetUserData (IntPtrTArray const &in_indices, ByteArrayArray const &in_data) |
CylinderKit & | SetVertexIndexColorsByList (size_t in_count, size_t const in_vertices[], float const in_indices[], Cylinder::Component in_apply_to=Cylinder::Component::Faces) |
CylinderKit & | SetVertexIndexColorsByList (SizeTArray const &in_vertices, FloatArray const &in_indices, Cylinder::Component in_apply_to=Cylinder::Component::Faces) |
CylinderKit & | SetVertexIndexColorsByList (size_t in_count, size_t const in_vertices[], float in_index, Cylinder::Component in_apply_to=Cylinder::Component::Faces) |
CylinderKit & | SetVertexIndexColorsByList (SizeTArray const &in_vertices, float in_index, Cylinder::Component in_apply_to=Cylinder::Component::Faces) |
CylinderKit & | SetVertexIndexColorsByRange (size_t in_start, size_t in_count, float const in_indices[], Cylinder::Component in_apply_to=Cylinder::Component::Faces) |
CylinderKit & | SetVertexIndexColorsByRange (size_t in_start, FloatArray const &in_indices, Cylinder::Component in_apply_to=Cylinder::Component::Faces) |
CylinderKit & | SetVertexIndexColorsByRange (size_t in_start, size_t in_count, float in_index, Cylinder::Component in_apply_to=Cylinder::Component::Faces) |
CylinderKit & | SetVertexRGBColorsByList (size_t in_count, size_t const in_vertices[], RGBColor const in_rgb_colors[], Cylinder::Component in_apply_to=Cylinder::Component::Faces) |
CylinderKit & | SetVertexRGBColorsByList (SizeTArray const &in_vertices, RGBColorArray const &in_rgb_colors, Cylinder::Component in_apply_to=Cylinder::Component::Faces) |
CylinderKit & | SetVertexRGBColorsByList (size_t in_count, size_t const in_vertices[], RGBColor const &in_rgb_color, Cylinder::Component in_apply_to=Cylinder::Component::Faces) |
CylinderKit & | SetVertexRGBColorsByList (SizeTArray const &in_vertices, RGBColor const &in_rgb_color, Cylinder::Component in_apply_to=Cylinder::Component::Faces) |
CylinderKit & | SetVertexRGBColorsByRange (size_t in_start, size_t in_count, RGBColor const in_rgb_colors[], Cylinder::Component in_apply_to=Cylinder::Component::Faces) |
CylinderKit & | SetVertexRGBColorsByRange (size_t in_start, RGBColorArray const &in_rgb_colors, Cylinder::Component in_apply_to=Cylinder::Component::Faces) |
CylinderKit & | SetVertexRGBColorsByRange (size_t in_start, size_t in_count, RGBColor const &in_rgb_color, Cylinder::Component in_apply_to=Cylinder::Component::Faces) |
void | Show (CylinderKit &out_kit) const |
bool | ShowCaps (Cylinder::Capping &out_caps) const |
bool | ShowPoints (PointArray &out_points) const |
bool | ShowPointsByList (SizeTArray const &in_indices, PointArray &out_points) const |
bool | ShowPointsByList (size_t in_count, size_t const in_indices[], PointArray &out_points) const |
bool | ShowPointsByRange (size_t in_start_index, size_t in_count, PointArray &out_points) const |
bool | ShowPriority (int &out_priority) const |
bool | ShowRadii (FloatArray &out_radii) const |
bool | ShowUserData (intptr_t in_index, ByteArray &out_data) const |
bool | ShowUserData (IntPtrTArray &out_indices, ByteArrayArray &out_data) const |
size_t | ShowUserDataCount () const |
bool | ShowUserDataIndices (IntPtrTArray &out_indices) const |
bool | ShowVertexColors (Cylinder::Component in_apply_to, MaterialTypeArray &out_types, RGBColorArray &out_rgb_colors, FloatArray &out_indices) const |
bool | ShowVertexColorsByList (SizeTArray const &in_vertices, Cylinder::Component in_apply_to, MaterialTypeArray &out_types, RGBColorArray &out_rgb_colors, FloatArray &out_indices) const |
bool | ShowVertexColorsByRange (size_t in_start, size_t in_count, Cylinder::Component in_apply_to, MaterialTypeArray &out_types, RGBColorArray &out_rgb_colors, FloatArray &out_indices) const |
CylinderKit & | UnsetAllUserData () |
CylinderKit & | UnsetCaps () |
CylinderKit & | UnsetEverything () |
CylinderKit & | UnsetPoints () |
CylinderKit & | UnsetPriority () |
CylinderKit & | UnsetRadii () |
CylinderKit & | UnsetUserData (intptr_t in_index) |
CylinderKit & | UnsetUserData (size_t in_count, intptr_t const in_indices[]) |
CylinderKit & | UnsetUserData (IntPtrTArray const &in_indices) |
CylinderKit & | UnsetVertexColors () |
CylinderKit & | UnsetVertexColors (Cylinder::Component in_apply_to) |
CylinderKit & | UnsetVertexColorsByList (SizeTArray const &in_vertices) |
CylinderKit & | UnsetVertexColorsByList (SizeTArray const &in_vertices, Cylinder::Component in_apply_to) |
CylinderKit & | UnsetVertexColorsByList (size_t in_count, size_t const in_vertices[]) |
CylinderKit & | UnsetVertexColorsByList (size_t in_count, size_t const in_vertices[], Cylinder::Component in_apply_to) |
CylinderKit & | UnsetVertexColorsByRange (size_t in_start, size_t in_count) |
CylinderKit & | UnsetVertexColorsByRange (size_t in_start, size_t in_count, Cylinder::Component in_apply_to) |
![]() | |
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 Attributes | |
static const HPS::Type | staticType = HPS::Type::CylinderKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::Kit |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
Kit (Kit &&in_that) | |
Kit & | operator= (Kit &&in_that) |
Detailed Description
The CylinderKit class is a user space object. It is a kit analog to a CylinderKey.
Constructor & Destructor Documentation
◆ CylinderKit() [1/3]
HPS::CylinderKit::CylinderKit | ( | ) |
The default constructor creates an empty CylinderKit object.
◆ CylinderKit() [2/3]
HPS::CylinderKit::CylinderKit | ( | CylinderKit const & | in_kit | ) |
The copy constructor creates a new CylinderKit object that contains the same settings as the source CylinderKit.
- Parameters
-
in_kit The source CylinderKit to copy.
◆ CylinderKit() [3/3]
HPS::CylinderKit::CylinderKit | ( | CylinderKit && | in_that | ) |
The move constructor creates a CylinderKit by transferring the underlying impl of the rvalue reference to this CylinderKit thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to a CylinderKit to take the impl from.
Member Function Documentation
◆ Consume()
void HPS::CylinderKit::Consume | ( | CylinderKit & | in_kit | ) |
Copies the source CylinderKit into this CylinderKit and resets the source kit.
- Parameters
-
in_kit The source CylinderKit to consume.
◆ Empty()
|
virtual |
Indicates whether this CylinderKit has any values set on it.
- Returns
- true if no values are set on this CylinderKit, false otherwise.
Reimplemented from HPS::Object.
◆ Equals()
bool HPS::CylinderKit::Equals | ( | CylinderKit const & | in_kit | ) | const |
Check if the source CylinderKit is equivalent to this CylinderKit.
- Parameters
-
in_kit The source CylinderKit to compare to this CylinderKit.
- Returns
- true if the objects are equivalent, false otherwise.
◆ GetPointCount()
size_t HPS::CylinderKit::GetPointCount | ( | ) | const |
Retrieves the number of points in this cylinder.
- Returns
- The number of points in this cylinder.
◆ ObjectType()
|
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.
◆ operator!=()
bool HPS::CylinderKit::operator!= | ( | CylinderKit const & | in_kit | ) | const |
Check if the source CylinderKit is not equivalent to this CylinderKit.
- Parameters
-
in_kit The source CylinderKit to compare to this CylinderKit.
- Returns
- true if the objects are not equivalent, false otherwise.
◆ operator=() [1/2]
CylinderKit& HPS::CylinderKit::operator= | ( | CylinderKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this CylinderKit thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to a CylinderKit to take the impl from.
- Returns
- A reference to this CylinderKit.
◆ operator=() [2/2]
CylinderKit& HPS::CylinderKit::operator= | ( | CylinderKit const & | in_kit | ) |
Copies the source CylinderKit into this CylinderKit.
- Parameters
-
in_kit The source CylinderKit to copy.
- Returns
- A reference to this CylinderKit.
◆ operator==()
bool HPS::CylinderKit::operator== | ( | CylinderKit const & | in_kit | ) | const |
Check if the source CylinderKit is equivalent to this CylinderKit.
- Parameters
-
in_kit The source CylinderKit to compare to this CylinderKit.
- Returns
- true if the objects are equivalent, false otherwise.
◆ Set()
void HPS::CylinderKit::Set | ( | CylinderKit const & | in_kit | ) |
Copies the source CylinderKit into this CylinderKit.
- Parameters
-
in_kit The source CylinderKit to copy.
◆ SetCaps()
CylinderKit& HPS::CylinderKit::SetCaps | ( | Cylinder::Capping | in_capping | ) |
Sets the capping for this CylinderKit.
- Parameters
-
in_capping The capping for this CylinderKit.
- Returns
- A reference to this CylinderKit.
◆ SetPoints() [1/2]
CylinderKit& HPS::CylinderKit::SetPoints | ( | PointArray const & | in_points | ) |
Sets the points for this CylinderKit.
- Parameters
-
in_points The points for this CylinderKit.
- Returns
- A reference to this CylinderKit.
◆ SetPoints() [2/2]
CylinderKit& HPS::CylinderKit::SetPoints | ( | size_t | in_count, |
Point const | in_points[] | ||
) |
Sets the points for this CylinderKit.
- Parameters
-
in_count Size of the following array. in_points The points for this CylinderKit.
- Returns
- A reference to this CylinderKit.
◆ SetPriority()
CylinderKit& HPS::CylinderKit::SetPriority | ( | int | in_priority | ) |
Assigns a specific drawing priority value to the CylinderKit. It affects the order in which the contents of this segment are drawn if and only if the rendering algorithm is set to Priority.
- Parameters
-
in_priority The drawing priority, higher priority items are drawn on top of lower priority items.
- Returns
- A reference to this object.
- See also
- SubwindowKit::SetPriority()
- SubwindowKit::SetRenderingAlgorithm()
◆ SetRadii() [1/2]
CylinderKit& HPS::CylinderKit::SetRadii | ( | FloatArray const & | in_radii | ) |
Sets the radii for this CylinderKit. If the size of the radii array is smaller than the point array, the radii array will be walked repeatedly to determine the radius for all points.
- Parameters
-
in_radii The radii for this CylinderKit.
- Returns
- A reference to this CylinderKit.
◆ SetRadii() [2/2]
CylinderKit& HPS::CylinderKit::SetRadii | ( | size_t | in_count, |
float const | in_radii[] | ||
) |
Sets the radii for this CylinderKit. If the size of the radii array is smaller than the point array, the radii array will be walked repeatedly to determine the radius for all points.
- Parameters
-
in_count Size of the following array. in_radii The radii for this CylinderKit.
- Returns
- A reference to this CylinderKit.
◆ SetUserData() [1/3]
CylinderKit& HPS::CylinderKit::SetUserData | ( | intptr_t | in_index, |
size_t | in_bytes, | ||
byte const | in_data[] | ||
) |
Sets user data on this kit.
- Parameters
-
in_index The index of the user data to set. in_bytes The number of bytes of user data to set. in_data The bytes of user data to set.
- Returns
- A reference to this kit.
◆ SetUserData() [2/3]
CylinderKit& HPS::CylinderKit::SetUserData | ( | intptr_t | in_index, |
ByteArray const & | in_data | ||
) |
Sets user data on this kit.
- Parameters
-
in_index The index of the user data to set. in_data The bytes of user data to set.
- Returns
- A reference to this kit.
◆ SetUserData() [3/3]
CylinderKit& HPS::CylinderKit::SetUserData | ( | IntPtrTArray const & | in_indices, |
ByteArrayArray const & | in_data | ||
) |
Sets user data on this kit.
- Parameters
-
in_indices An array of user data indices to set. in_data An array of bytes of user data to set.
- Returns
- A reference to this kit.
◆ SetVertexIndexColorsByList() [1/4]
CylinderKit& HPS::CylinderKit::SetVertexIndexColorsByList | ( | size_t | in_count, |
size_t const | in_vertices[], | ||
float const | in_indices[], | ||
Cylinder::Component | in_apply_to = Cylinder::Component::Faces |
||
) |
Sets vertex material indices on a selection of arbitrary vertices which apply to the specified cylinder component.
- Parameters
-
in_count Size of the following arrays. in_vertices The indices of the vertices on which to set the colors. in_indices The material indices to set on the vertices. in_apply_to The cylinder component the colors should apply to. Defaults to Cylinder::Component::Faces.
- Returns
- A reference to this CylinderKit.
◆ SetVertexIndexColorsByList() [2/4]
CylinderKit& HPS::CylinderKit::SetVertexIndexColorsByList | ( | SizeTArray const & | in_vertices, |
FloatArray const & | in_indices, | ||
Cylinder::Component | in_apply_to = Cylinder::Component::Faces |
||
) |
Sets vertex material indices on a selection of arbitrary vertices which apply to the specified cylinder component. If the sizes of the vertex index and material index arrays are different, the smaller size will be used.
- Parameters
-
in_vertices The indices of the vertices on which to set the colors. in_indices The material indices to set on the vertices. in_apply_to The cylinder component the colors should apply to. Defaults to Cylinder::Component::Faces.
- Returns
- A reference to this CylinderKit.
◆ SetVertexIndexColorsByList() [3/4]
CylinderKit& HPS::CylinderKit::SetVertexIndexColorsByList | ( | size_t | in_count, |
size_t const | in_vertices[], | ||
float | in_index, | ||
Cylinder::Component | in_apply_to = Cylinder::Component::Faces |
||
) |
Sets a single material index on a selection of arbitrary vertices which apply to the specified cylinder component.
- Parameters
-
in_count Size of the following array. in_vertices The indices of the vertices on which to set the color. in_index The material index to set on the vertices. in_apply_to The cylinder component the colors should apply to. Defaults to Cylinder::Component::Faces.
- Returns
- A reference to this CylinderKit.
◆ SetVertexIndexColorsByList() [4/4]
CylinderKit& HPS::CylinderKit::SetVertexIndexColorsByList | ( | SizeTArray const & | in_vertices, |
float | in_index, | ||
Cylinder::Component | in_apply_to = Cylinder::Component::Faces |
||
) |
Sets a single material index on a selection of arbitrary vertices which apply to the specified cylinder component.
- Parameters
-
in_vertices The indices of the vertices on which to set the color. in_index The material index to set on the vertices. in_apply_to The cylinder component the colors should apply to. Defaults to Cylinder::Component::Faces.
- Returns
- A reference to this CylinderKit.
◆ SetVertexIndexColorsByRange() [1/3]
CylinderKit& HPS::CylinderKit::SetVertexIndexColorsByRange | ( | size_t | in_start, |
size_t | in_count, | ||
float const | in_indices[], | ||
Cylinder::Component | in_apply_to = Cylinder::Component::Faces |
||
) |
Sets vertex material indices on a range of vertices starting at the specified offset which apply to the specified cylinder component.
- Parameters
-
in_start The offset into the vertices for this CylinderKit at which to start setting colors. in_count Size of the following array. in_indices The material indices to set on the vertices for this CylinderKit. in_apply_to The cylinder component the colors should apply to. Defaults to Cylinder::Component::Faces.
- Returns
- A reference to this CylinderKit.
◆ SetVertexIndexColorsByRange() [2/3]
CylinderKit& HPS::CylinderKit::SetVertexIndexColorsByRange | ( | size_t | in_start, |
FloatArray const & | in_indices, | ||
Cylinder::Component | in_apply_to = Cylinder::Component::Faces |
||
) |
Sets vertex material indices on a range of vertices starting at the specified offset which apply to the specified cylinder component.
- Parameters
-
in_start The offset into the vertices for this CylinderKit at which to start setting colors. in_indices The material indices to set on the vertices for this CylinderKit. in_apply_to The cylinder component the colors should apply to. Defaults to Cylinder::Component::Faces.
- Returns
- A reference to this CylinderKit.
◆ SetVertexIndexColorsByRange() [3/3]
CylinderKit& HPS::CylinderKit::SetVertexIndexColorsByRange | ( | size_t | in_start, |
size_t | in_count, | ||
float | in_index, | ||
Cylinder::Component | in_apply_to = Cylinder::Component::Faces |
||
) |
Sets a single material index on a range of vertices starting at the specified offset which apply to the specified cylinder component.
- Parameters
-
in_start The offset into the vertices for this CylinderKit at which to start setting the color. in_count The number of vertices on which to set the color. in_index The material index to set on the vertices for this CylinderKit. in_apply_to The cylinder component the colors should apply to. Defaults to Cylinder::Component::Faces.
- Returns
- A reference to this CylinderKit.
◆ SetVertexRGBColorsByList() [1/4]
CylinderKit& HPS::CylinderKit::SetVertexRGBColorsByList | ( | size_t | in_count, |
size_t const | in_vertices[], | ||
RGBColor const | in_rgb_colors[], | ||
Cylinder::Component | in_apply_to = Cylinder::Component::Faces |
||
) |
Sets vertex RGB colors on a selection of arbitrary vertices which apply to the specified cylinder component.
- Parameters
-
in_count Size of the following arrays. in_vertices The indices of the vertices on which to set the colors. in_rgb_colors The RGB colors to set on the vertices. in_apply_to The cylinder component the colors should apply to. Defaults to Cylinder::Component::Faces.
- Returns
- A reference to this CylinderKit.
◆ SetVertexRGBColorsByList() [2/4]
CylinderKit& HPS::CylinderKit::SetVertexRGBColorsByList | ( | SizeTArray const & | in_vertices, |
RGBColorArray const & | in_rgb_colors, | ||
Cylinder::Component | in_apply_to = Cylinder::Component::Faces |
||
) |
Sets vertex RGB colors on a selection of arbitrary vertices which apply to the specified cylinder component. If the sizes of the vertex index array and the color array different, the smaller size will be used.
- Parameters
-
in_vertices The indices of the vertices on which to set the colors. in_rgb_colors The RGB colors to set on the vertices. in_apply_to The cylinder component the colors should apply to. Defaults to Cylinder::Component::Faces.
- Returns
- A reference to this CylinderKit.
◆ SetVertexRGBColorsByList() [3/4]
CylinderKit& HPS::CylinderKit::SetVertexRGBColorsByList | ( | size_t | in_count, |
size_t const | in_vertices[], | ||
RGBColor const & | in_rgb_color, | ||
Cylinder::Component | in_apply_to = Cylinder::Component::Faces |
||
) |
Sets a single RGB color on a selection of arbitrary vertices which apply to the specified cylinder component.
- Parameters
-
in_count Size of the following array. in_vertices The indices of the vertices on which to set the color. in_rgb_color The RGB color to set on the vertices. in_apply_to The cylinder component the colors should apply to. Defaults to Cylinder::Component::Faces.
- Returns
- A reference to this CylinderKit.
◆ SetVertexRGBColorsByList() [4/4]
CylinderKit& HPS::CylinderKit::SetVertexRGBColorsByList | ( | SizeTArray const & | in_vertices, |
RGBColor const & | in_rgb_color, | ||
Cylinder::Component | in_apply_to = Cylinder::Component::Faces |
||
) |
Sets a single RGB color on a selection of arbitrary vertices which apply to the specified cylinder component.
- Parameters
-
in_vertices The indices of the vertices on which to set the color. in_rgb_color The RGB color to set on the vertices. in_apply_to The cylinder component the colors should apply to. Defaults to Cylinder::Component::Faces.
- Returns
- A reference to this CylinderKit.
◆ SetVertexRGBColorsByRange() [1/3]
CylinderKit& HPS::CylinderKit::SetVertexRGBColorsByRange | ( | size_t | in_start, |
size_t | in_count, | ||
RGBColor const | in_rgb_colors[], | ||
Cylinder::Component | in_apply_to = Cylinder::Component::Faces |
||
) |
Sets vertex RGB colors on a range of vertices starting at the specified offset which apply to the specified cylinder component.
- Parameters
-
in_start The offset into the vertices for this CylinderKit at which to start setting colors. in_count Size of the following array. in_rgb_colors The RGB colors to set on the vertices for this CylinderKit. in_apply_to The cylinder component the colors should apply to. Defaults to Cylinder::Component::Faces.
- Returns
- A reference to this CylinderKit.
◆ SetVertexRGBColorsByRange() [2/3]
CylinderKit& HPS::CylinderKit::SetVertexRGBColorsByRange | ( | size_t | in_start, |
RGBColorArray const & | in_rgb_colors, | ||
Cylinder::Component | in_apply_to = Cylinder::Component::Faces |
||
) |
Sets vertex RGB colors on a range of vertices starting at the specified offset which apply to the specified cylinder component.
- Parameters
-
in_start The offset into the vertices for this CylinderKit at which to start setting colors. in_rgb_colors The RGB colors to set on the vertices for this CylinderKit. in_apply_to The cylinder component the colors should apply to. Defaults to Cylinder::Component::Faces.
- Returns
- A reference to this CylinderKit.
◆ SetVertexRGBColorsByRange() [3/3]
CylinderKit& HPS::CylinderKit::SetVertexRGBColorsByRange | ( | size_t | in_start, |
size_t | in_count, | ||
RGBColor const & | in_rgb_color, | ||
Cylinder::Component | in_apply_to = Cylinder::Component::Faces |
||
) |
Sets a single RGB color on a range of vertices starting at the specified offset which apply to the specified cylinder component.
- Parameters
-
in_start The offset into the vertices for this CylinderKit at which to start setting the color. in_count The number of vertices on which to set the color. in_rgb_color The RGB color to set on the vertices for this CylinderKit. in_apply_to The cylinder component the colors should apply to. Defaults to Cylinder::Component::Faces.
- Returns
- A reference to this CylinderKit.
◆ Show()
void HPS::CylinderKit::Show | ( | CylinderKit & | out_kit | ) | const |
Copies this CylinderKit into the given CylinderKit.
- Parameters
-
out_kit The CylinderKit to populate with the contents of this CylinderKit.
◆ ShowCaps()
bool HPS::CylinderKit::ShowCaps | ( | Cylinder::Capping & | out_caps | ) | const |
Show the capping for this CylinderKit.
- Parameters
-
out_caps The capping for this CylinderKit.
- Returns
- true if a capping was set, false otherwise.
◆ ShowPoints()
bool HPS::CylinderKit::ShowPoints | ( | PointArray & | out_points | ) | const |
Show the points for this CylinderKit.
- Parameters
-
out_points The points for this CylinderKit.
- Returns
- true if points were set, false otherwise.
◆ ShowPointsByList() [1/2]
bool HPS::CylinderKit::ShowPointsByList | ( | SizeTArray const & | in_indices, |
PointArray & | out_points | ||
) | const |
Show a subset of the points for this CylinderKit by list.
- Parameters
-
in_indices The list of point indices to show. out_points The requested points for this CylinderKit.
- Returns
- true if all requested points were set, false otherwise.
◆ ShowPointsByList() [2/2]
bool HPS::CylinderKit::ShowPointsByList | ( | size_t | in_count, |
size_t const | in_indices[], | ||
PointArray & | out_points | ||
) | const |
Show a subset of the points for this CylinderKit by list.
- Parameters
-
in_count The number of points to show. in_indices The list of point indices to show. out_points The requested points for this CylinderKit.
- Returns
- true if all requested points were set, false otherwise.
◆ ShowPointsByRange()
bool HPS::CylinderKit::ShowPointsByRange | ( | size_t | in_start_index, |
size_t | in_count, | ||
PointArray & | out_points | ||
) | const |
Show a subset of the points for this CylinderKit by range.
- Parameters
-
in_start_index The first point to show. in_count The number of points to show. out_points The requested points for this CylinderKit.
- Returns
- true if all requested points were set, false otherwise.
◆ ShowPriority()
bool HPS::CylinderKit::ShowPriority | ( | int & | out_priority | ) | const |
Shows the drawing priority.
- Parameters
-
out_priority The drawing priority, higher priority items are drawn on top of lower priority items.
- Returns
- true if the setting is valid, false otherwise.
◆ ShowRadii()
bool HPS::CylinderKit::ShowRadii | ( | FloatArray & | out_radii | ) | const |
Show the radii for this CylinderKit.
- Parameters
-
out_radii The radii for this CylinderKit.
- Returns
- true if radii were set, false otherwise.
◆ ShowUserData() [1/2]
bool HPS::CylinderKit::ShowUserData | ( | intptr_t | in_index, |
ByteArray & | out_data | ||
) | const |
Shows the user data at a given index for this kit.
- Parameters
-
in_index The index of the user data to show. out_data The user data at the given index.
- Returns
- true if there is user data at the given index, false otherwise.
◆ ShowUserData() [2/2]
bool HPS::CylinderKit::ShowUserData | ( | IntPtrTArray & | out_indices, |
ByteArrayArray & | out_data | ||
) | const |
Shows all user data for this kit.
- Parameters
-
out_indices An array of all user data indices set on this kit. out_data An array of all user data set on this kit.
- Returns
- true if there is user data on this kit, false otherwise.
◆ ShowUserDataCount()
size_t HPS::CylinderKit::ShowUserDataCount | ( | ) | const |
Get the number of user data indices set on this kit.
◆ ShowUserDataIndices()
bool HPS::CylinderKit::ShowUserDataIndices | ( | IntPtrTArray & | out_indices | ) | const |
Shows the indices of all user data set on this kit.
- Parameters
-
out_indices The user data indices set on this kit.
- Returns
- The number of user data indices set on this kit.
◆ ShowVertexColors()
bool HPS::CylinderKit::ShowVertexColors | ( | Cylinder::Component | in_apply_to, |
MaterialTypeArray & | out_types, | ||
RGBColorArray & | out_rgb_colors, | ||
FloatArray & | out_indices | ||
) | const |
Shows all the vertex colors of the specified cylinder component.
- Parameters
-
in_apply_to The cylinder component the colors should apply to. out_types The types of vertex colors for each vertex. If a vertex does not have a vertex color set for the specified cylinder component, the entry in this array will be Material::Type::None. out_rgb_colors The RGB colors for each vertex. out_rgb_colors[i] is only valid if out_types[i] is Material::Type::RGBColor. out_indices The material indices for each vertex. The out_indices[i] is only valid if out_types[i] is Material::Type::MaterialIndex.
- Returns
- true if any vertex colors were shown, false otherwise.
◆ ShowVertexColorsByList()
bool HPS::CylinderKit::ShowVertexColorsByList | ( | SizeTArray const & | in_vertices, |
Cylinder::Component | in_apply_to, | ||
MaterialTypeArray & | out_types, | ||
RGBColorArray & | out_rgb_colors, | ||
FloatArray & | out_indices | ||
) | const |
Shows the vertex colors on a selection of arbitrary vertices which apply to the specified cylinder component. The order of the values in the ouput arrays is the same as the input vertex index array, i.e., the values of out_types[i], out_rgb_colors[i], out_rgba_colors[i], and out_indices[i], correspond to the vertex at index in_vertices[i].
- Parameters
-
in_vertices The indices of the vertices on which to show the colors. in_apply_to The cylinder component the colors should apply to. out_types The types of vertex colors for each vertex at the specified index. If a vertex at a specified index does not have a vertex color set for the specified component, the entry in this array will be Material::Type::None. out_rgb_colors The RGB colors for each vertex at the specified index. out_rgb_colors[i] is only valid if out_types[i] is Material::Type::RGBColor. out_indices The material indices for each vertex at the specified index. The out_indices[i] is only valid if out_types[i] is Material::Type::MaterialIndex.
- Returns
- true if any specified vertex had a vertex color on the specified component set, false otherwise.
◆ ShowVertexColorsByRange()
bool HPS::CylinderKit::ShowVertexColorsByRange | ( | size_t | in_start, |
size_t | in_count, | ||
Cylinder::Component | in_apply_to, | ||
MaterialTypeArray & | out_types, | ||
RGBColorArray & | out_rgb_colors, | ||
FloatArray & | out_indices | ||
) | const |
Shows the vertex colors on a range of vertices starting at the specified offset which apply to the specified cylinder component.
- Parameters
-
in_start The offset into the vertices for this CylinderKit at which to start showing colors. in_count The number of colors to show. in_apply_to The cylinder component the colors should apply to. out_types The types of vertex colors for each vertex in the specified range. If a vertex in the specified range does not have a vertex color set for the specified cylinder component, the entry in this array will be Material::Type::None. out_rgb_colors The RGB colors for each vertex in the specified range. out_rgb_colors[i] is only valid if out_types[i] is Material::Type::RGBColor. out_indices The material indices for each vertex in the specified range. The out_indices[i] is only valid if out_types[i] is Material::Type::MaterialIndex.
- Returns
- true if any vertex in the specified range had a vertex color on the specified component set, false otherwise.
◆ UnsetAllUserData()
CylinderKit& HPS::CylinderKit::UnsetAllUserData | ( | ) |
Removes all user data from this kit.
- Returns
- A reference to this kit.
◆ UnsetCaps()
CylinderKit& HPS::CylinderKit::UnsetCaps | ( | ) |
Removes the capping for this CylinderKit.
- Returns
- A reference to this CylinderKit.
◆ UnsetEverything()
CylinderKit& HPS::CylinderKit::UnsetEverything | ( | ) |
Removes all settings from the CylinderKit.
- Returns
- A reference to this CylinderKit.
◆ UnsetPoints()
CylinderKit& HPS::CylinderKit::UnsetPoints | ( | ) |
Removes the points for this CylinderKit.
- Returns
- A reference to this CylinderKit.
◆ UnsetPriority()
CylinderKit& HPS::CylinderKit::UnsetPriority | ( | ) |
Removes a drawing priority setting.
- Returns
- A reference to this object.
◆ UnsetRadii()
CylinderKit& HPS::CylinderKit::UnsetRadii | ( | ) |
Removes the radii for this CylinderKit.
- Returns
- A reference to this CylinderKit.
◆ UnsetUserData() [1/3]
CylinderKit& HPS::CylinderKit::UnsetUserData | ( | intptr_t | in_index | ) |
Removes the user data at the given index from this kit.
- Parameters
-
in_index The index of the user data to remove.
- Returns
- A reference to this kit.
◆ UnsetUserData() [2/3]
CylinderKit& HPS::CylinderKit::UnsetUserData | ( | size_t | in_count, |
intptr_t const | in_indices[] | ||
) |
Removes the user data at the given indices from this kit.
- Parameters
-
in_count The size of the following array. in_indices The indices of the user data to remove.
- Returns
- A reference to this kit.
◆ UnsetUserData() [3/3]
CylinderKit& HPS::CylinderKit::UnsetUserData | ( | IntPtrTArray const & | in_indices | ) |
Removes the user data at the given indices from this kit.
- Parameters
-
in_indices The indices of the user data to remove.
- Returns
- A reference to this kit.
◆ UnsetVertexColors() [1/2]
CylinderKit& HPS::CylinderKit::UnsetVertexColors | ( | ) |
Removes all vertex colors (RGB colors or material indices) for all cylinder components.
- Returns
- A reference to this CylinderKit.
◆ UnsetVertexColors() [2/2]
CylinderKit& HPS::CylinderKit::UnsetVertexColors | ( | Cylinder::Component | in_apply_to | ) |
Removes all vertex colors (RGB colors or material indices) for the specified cylinder component.
- Parameters
-
in_apply_to The cylinder component for which to remove the colors.
- Returns
- A reference to this CylinderKit.
◆ UnsetVertexColorsByList() [1/4]
CylinderKit& HPS::CylinderKit::UnsetVertexColorsByList | ( | SizeTArray const & | in_vertices | ) |
Removes the vertex colors (RGB colors or material indices) for all cylinder components on a selection of arbitrary vertices.
- Parameters
-
in_vertices The indices of the vertices on which to remove the colors.
- Returns
- A reference to this CylinderKit.
◆ UnsetVertexColorsByList() [2/4]
CylinderKit& HPS::CylinderKit::UnsetVertexColorsByList | ( | SizeTArray const & | in_vertices, |
Cylinder::Component | in_apply_to | ||
) |
Removes the vertex colors (RGB colors or material indices) for the specified cylinder component on a selection of arbitrary vertices.
- Parameters
-
in_vertices The indices of the vertices on which to remove the colors. in_apply_to The cylinder component for which to remove the colors.
- Returns
- A reference to this CylinderKit.
◆ UnsetVertexColorsByList() [3/4]
CylinderKit& HPS::CylinderKit::UnsetVertexColorsByList | ( | size_t | in_count, |
size_t const | in_vertices[] | ||
) |
Removes the vertex visibilities on a selection of arbitrary vertices.
- Parameters
-
in_count The number of vertex visibilities to remove for this CylinderKit. in_vertices The indices of the vertices on which to remove the visibilities.
- Returns
- A reference to this CylinderKit.
◆ UnsetVertexColorsByList() [4/4]
CylinderKit& HPS::CylinderKit::UnsetVertexColorsByList | ( | size_t | in_count, |
size_t const | in_vertices[], | ||
Cylinder::Component | in_apply_to | ||
) |
Removes the vertex visibilities on a selection of arbitrary vertices.
- Parameters
-
in_count The number of vertex visibilities to remove for this CylinderKit. in_vertices The indices of the vertices on which to remove the visibilities. in_apply_to The cylinder component that should be unset.
- Returns
- A reference to this CylinderKit.
◆ UnsetVertexColorsByRange() [1/2]
CylinderKit& HPS::CylinderKit::UnsetVertexColorsByRange | ( | size_t | in_start, |
size_t | in_count | ||
) |
Removes the specified range of vertex colors (RGB colors or material indices) for all cylinder components starting at the specified offset.
- Parameters
-
in_start The offset into the vertices for this CylinderKit at which to start removing colors. in_count The number of vertex colors to remove for this CylinderKit.
- Returns
- A reference to this CylinderKit.
◆ UnsetVertexColorsByRange() [2/2]
CylinderKit& HPS::CylinderKit::UnsetVertexColorsByRange | ( | size_t | in_start, |
size_t | in_count, | ||
Cylinder::Component | in_apply_to | ||
) |
Removes the specified range of vertex colors (RGB colors or material indices) for the specified cylinder component starting at the specified offset.
- Parameters
-
in_start The offset into the vertices for this CylinderKit at which to start removing colors. in_count The number of vertex colors to remove for this CylinderKit. in_apply_to The cylinder component for which to remove the colors.
- Returns
- A reference to this CylinderKit.
The documentation for this class was generated from the following file:
- include/hps.h