#include <hps.h>

Public Member Functions | |
void | ComputeRelation (PointArray const &in_points, ShellRelationOptionsKit const &in_options, ShellRelationResultsKit &out_results) const |
void | ComputeRelation (ShellKey const &in_points_source, ShellRelationOptionsKit const &in_options, ShellRelationResultsKit &out_results) const |
void | ComputeRelation (ShellKit const &in_points_source, ShellRelationOptionsKit const &in_options, ShellRelationResultsKit &out_results) const |
void | Consume (ShellKit &in_kit) |
ShellKit & | EditFacelistByDeletion (size_t in_offset, size_t in_count) |
ShellKit & | EditFacelistByInsertion (size_t in_offset, size_t in_count, int const in_facelist[]) |
ShellKit & | EditFacelistByInsertion (size_t in_offset, IntArray const &in_facelist) |
ShellKit & | EditFacelistByReplacement (size_t in_offset, size_t in_count, int const in_facelist[]) |
ShellKit & | EditFacelistByReplacement (size_t in_offset, IntArray const &in_facelist) |
ShellKit & | EditPointsByDeletion (size_t in_offset, size_t in_count) |
ShellKit & | EditPointsByInsertion (size_t in_offset, size_t in_count, Point const in_points[]) |
ShellKit & | EditPointsByInsertion (size_t in_offset, PointArray const &in_points) |
ShellKit & | EditPointsByReplacement (size_t in_offset, size_t in_count, Point const in_points[]) |
ShellKit & | EditPointsByReplacement (size_t in_offset, PointArray const &in_points) |
bool | Empty () const |
bool | Equals (ShellKit const &in_kit) const |
size_t | GetFaceCount () const |
size_t | GetPointCount () const |
HPS::Type | ObjectType () const |
bool | operator!= (ShellKit const &in_kit) const |
ShellKit & | operator= (ShellKit &&in_that) |
ShellKit & | operator= (ShellKit const &in_kit) |
bool | operator== (ShellKit const &in_kit) const |
void | Optimize (ShellOptimizationOptionsKit const &in_shell_optimization_kit) |
void | Set (ShellKit const &in_kit) |
ShellKit & | SetFaceIndexColorsByList (size_t in_count, size_t const in_faces[], float const in_indices[]) |
ShellKit & | SetFaceIndexColorsByList (SizeTArray const &in_faces, FloatArray const &in_indices) |
ShellKit & | SetFaceIndexColorsByList (size_t in_count, size_t const in_faces[], float in_index) |
ShellKit & | SetFaceIndexColorsByList (SizeTArray const &in_faces, float in_index) |
ShellKit & | SetFaceIndexColorsByRange (size_t in_start, size_t in_count, float const in_indices[]) |
ShellKit & | SetFaceIndexColorsByRange (size_t in_start, FloatArray const &in_indices) |
ShellKit & | SetFaceIndexColorsByRange (size_t in_start, size_t in_count, float in_index) |
ShellKit & | SetFacelist (IntArray const &in_facelist) |
ShellKit & | SetFacelist (size_t in_count, int const in_facelist[]) |
ShellKit & | SetFaceNormalsByList (size_t in_count, size_t const in_faces[], Vector const in_normals[]) |
ShellKit & | SetFaceNormalsByList (SizeTArray const &in_faces, VectorArray const &in_normals) |
ShellKit & | SetFaceNormalsByList (size_t in_count, size_t const in_faces[], Vector const &in_normal) |
ShellKit & | SetFaceNormalsByList (SizeTArray const &in_faces, Vector const &in_normal) |
ShellKit & | SetFaceNormalsByRange (size_t in_start, size_t in_count, Vector const in_normals[]) |
ShellKit & | SetFaceNormalsByRange (size_t in_start, VectorArray const &in_normals) |
ShellKit & | SetFaceNormalsByRange (size_t in_start, size_t in_count, Vector const &in_normal) |
ShellKit & | SetFaceRGBColorsByList (size_t in_count, size_t const in_faces[], RGBColor const in_rgb_colors[]) |
ShellKit & | SetFaceRGBColorsByList (SizeTArray const &in_faces, RGBColorArray const &in_rgb_colors) |
ShellKit & | SetFaceRGBColorsByList (size_t in_count, size_t const in_faces[], RGBColor const &in_rgb_color) |
ShellKit & | SetFaceRGBColorsByList (SizeTArray const &in_faces, RGBColor const &in_rgb_color) |
ShellKit & | SetFaceRGBColorsByRange (size_t in_start, size_t in_count, RGBColor const in_rgb_colors[]) |
ShellKit & | SetFaceRGBColorsByRange (size_t in_start, RGBColorArray const &in_rgb_colors) |
ShellKit & | SetFaceRGBColorsByRange (size_t in_start, size_t in_count, RGBColor const &in_rgb_color) |
ShellKit & | SetFaceVisibilitiesByList (size_t in_count, size_t const in_faces[], bool const in_visibilities[]) |
ShellKit & | SetFaceVisibilitiesByList (SizeTArray const &in_faces, BoolArray const &in_visibilities) |
ShellKit & | SetFaceVisibilitiesByList (size_t in_count, size_t const in_faces[], bool in_visibility) |
ShellKit & | SetFaceVisibilitiesByList (SizeTArray const &in_faces, bool in_visibility) |
ShellKit & | SetFaceVisibilitiesByRange (size_t in_start, size_t in_count, bool const in_visibilities[]) |
ShellKit & | SetFaceVisibilitiesByRange (size_t in_start, BoolArray const &in_visibilities) |
ShellKit & | SetFaceVisibilitiesByRange (size_t in_start, size_t in_count, bool in_visibility) |
ShellKit & | SetMaterialMapping (MaterialMappingKit const &in_kit) |
ShellKit & | SetPoints (PointArray const &in_points) |
ShellKit & | SetPoints (size_t in_count, Point const in_points[]) |
ShellKit & | SetPriority (int in_priority) |
ShellKit & | SetTristrips (IntArray const &in_tristrips) |
ShellKit & | SetTristrips (size_t in_count, int const in_tristrips[]) |
ShellKit & | SetUserData (intptr_t in_index, size_t in_bytes, byte const in_data[]) |
ShellKit & | SetUserData (intptr_t in_index, ByteArray const &in_data) |
ShellKit & | SetUserData (IntPtrTArray const &in_indices, ByteArrayArray const &in_data) |
ShellKit & | SetVertexIndexColorsByList (size_t in_count, size_t const in_vertices[], float const in_indices[], Shell::Component in_apply_to=Shell::Component::Faces) |
ShellKit & | SetVertexIndexColorsByList (SizeTArray const &in_vertices, FloatArray const &in_indices, Shell::Component in_apply_to=Shell::Component::Faces) |
ShellKit & | SetVertexIndexColorsByList (size_t in_count, size_t const in_vertices[], float in_index, Shell::Component in_apply_to=Shell::Component::Faces) |
ShellKit & | SetVertexIndexColorsByList (SizeTArray const &in_vertices, float in_index, Shell::Component in_apply_to=Shell::Component::Faces) |
ShellKit & | SetVertexIndexColorsByRange (size_t in_start, size_t in_count, float const in_indices[], Shell::Component in_apply_to=Shell::Component::Faces) |
ShellKit & | SetVertexIndexColorsByRange (size_t in_start, FloatArray const &in_indices, Shell::Component in_apply_to=Shell::Component::Faces) |
ShellKit & | SetVertexIndexColorsByRange (size_t in_start, size_t in_count, float in_index, Shell::Component in_apply_to=Shell::Component::Faces) |
ShellKit & | SetVertexNormalsByList (size_t in_count, size_t const in_vertices[], Vector const in_normals[]) |
ShellKit & | SetVertexNormalsByList (SizeTArray const &in_vertices, VectorArray const &in_normals) |
ShellKit & | SetVertexNormalsByList (size_t in_count, size_t const in_vertices[], Vector const &in_normal) |
ShellKit & | SetVertexNormalsByList (SizeTArray const &in_vertices, Vector const &in_normal) |
ShellKit & | SetVertexNormalsByRange (size_t in_start, size_t in_count, Vector const in_normals[]) |
ShellKit & | SetVertexNormalsByRange (size_t in_start, VectorArray const &in_normals) |
ShellKit & | SetVertexNormalsByRange (size_t in_start, size_t in_count, Vector const &in_normal) |
ShellKit & | SetVertexParametersByList (size_t in_vertex_count, size_t const in_vertices[], size_t in_param_count, float const in_params[], size_t in_param_width=2) |
ShellKit & | SetVertexParametersByList (SizeTArray const &in_vertices, FloatArray const &in_params, size_t in_param_width=2) |
ShellKit & | SetVertexParametersByRange (size_t in_start, size_t in_param_count, float const in_params[], size_t in_param_width=2) |
ShellKit & | SetVertexParametersByRange (size_t in_start, FloatArray const &in_params, size_t in_param_width=2) |
ShellKit & | SetVertexRGBAColorsByList (size_t in_count, size_t const in_vertices[], RGBAColor const in_rgba_colors[], Shell::Component in_apply_to=Shell::Component::Faces) |
ShellKit & | SetVertexRGBAColorsByList (SizeTArray const &in_vertices, RGBAColorArray const &in_rgba_colors, Shell::Component in_apply_to=Shell::Component::Faces) |
ShellKit & | SetVertexRGBAColorsByList (size_t in_count, size_t const in_vertices[], RGBAColor const &in_rgba_color, Shell::Component in_apply_to=Shell::Component::Faces) |
ShellKit & | SetVertexRGBAColorsByList (SizeTArray const &in_vertices, RGBAColor const &in_rgba_color, Shell::Component in_apply_to=Shell::Component::Faces) |
ShellKit & | SetVertexRGBAColorsByRange (size_t in_start, size_t in_count, RGBAColor const in_rgba_colors[], Shell::Component in_apply_to=Shell::Component::Faces) |
ShellKit & | SetVertexRGBAColorsByRange (size_t in_start, RGBAColorArray const &in_rgba_colors, Shell::Component in_apply_to=Shell::Component::Faces) |
ShellKit & | SetVertexRGBAColorsByRange (size_t in_start, size_t in_count, RGBAColor const &in_rgba_color, Shell::Component in_apply_to=Shell::Component::Faces) |
ShellKit & | SetVertexRGBColorsByList (size_t in_count, size_t const in_vertices[], RGBColor const in_rgb_colors[], Shell::Component in_apply_to=Shell::Component::Faces) |
ShellKit & | SetVertexRGBColorsByList (SizeTArray const &in_vertices, RGBColorArray const &in_rgb_colors, Shell::Component in_apply_to=Shell::Component::Faces) |
ShellKit & | SetVertexRGBColorsByList (size_t in_count, size_t const in_vertices[], RGBColor const &in_rgb_color, Shell::Component in_apply_to=Shell::Component::Faces) |
ShellKit & | SetVertexRGBColorsByList (SizeTArray const &in_vertices, RGBColor const &in_rgb_color, Shell::Component in_apply_to=Shell::Component::Faces) |
ShellKit & | SetVertexRGBColorsByRange (size_t in_start, size_t in_count, RGBColor const in_rgb_colors[], Shell::Component in_apply_to=Shell::Component::Faces) |
ShellKit & | SetVertexRGBColorsByRange (size_t in_start, RGBColorArray const &in_rgb_colors, Shell::Component in_apply_to=Shell::Component::Faces) |
ShellKit & | SetVertexRGBColorsByRange (size_t in_start, size_t in_count, RGBColor const &in_rgb_color, Shell::Component in_apply_to=Shell::Component::Faces) |
ShellKit & | SetVertexVisibilitiesByList (size_t in_count, size_t const in_vertices[], bool const in_visibilities[]) |
ShellKit & | SetVertexVisibilitiesByList (SizeTArray const &in_vertices, BoolArray const &in_visibilities) |
ShellKit & | SetVertexVisibilitiesByList (size_t in_count, size_t const in_vertices[], bool in_visibility) |
ShellKit & | SetVertexVisibilitiesByList (SizeTArray const &in_vertices, bool in_visibility) |
ShellKit & | SetVertexVisibilitiesByRange (size_t in_start, size_t in_count, bool const in_visibilities[]) |
ShellKit & | SetVertexVisibilitiesByRange (size_t in_start, BoolArray const &in_visibilities) |
ShellKit & | SetVertexVisibilitiesByRange (size_t in_start, size_t in_count, bool in_visibility) |
ShellKit () | |
ShellKit (ShellKit const &in_kit) | |
ShellKit (ShellKit &&in_that) | |
void | Show (ShellKit &out_kit) const |
bool | ShowFaceColors (MaterialTypeArray &out_types, RGBColorArray &out_rgb_colors, FloatArray &out_indices) const |
bool | ShowFaceColorsByList (SizeTArray const &in_faces, MaterialTypeArray &out_types, RGBColorArray &out_rgb_colors, FloatArray &out_indices) const |
bool | ShowFaceColorsByRange (size_t in_start, size_t in_count, MaterialTypeArray &out_types, RGBColorArray &out_rgb_colors, FloatArray &out_indices) const |
bool | ShowFacelist (IntArray &out_facelist) const |
bool | ShowFaceNormals (BoolArray &out_validities, VectorArray &out_normals) const |
bool | ShowFaceNormalsByList (SizeTArray const &in_faces, BoolArray &out_validities, VectorArray &out_normals) const |
bool | ShowFaceNormalsByRange (size_t in_start, size_t in_count, BoolArray &out_validities, VectorArray &out_normals) const |
bool | ShowFaceVisibilities (BoolArray &out_validities, BoolArray &out_visibilities) const |
bool | ShowFaceVisibilitiesByList (SizeTArray const &in_faces, BoolArray &out_validities, BoolArray &out_visibilities) const |
bool | ShowFaceVisibilitiesByRange (size_t in_start, size_t in_count, BoolArray &out_validities, BoolArray &out_visibilities) const |
bool | ShowMaterialMapping (MaterialMappingKit &out_kit) 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 | ShowTristrips (IntArray &out_tristrips) 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 (Shell::Component in_apply_to, MaterialTypeArray &out_types, RGBColorArray &out_rgb_colors, RGBAColorArray &out_rgba_colors, FloatArray &out_indices) const |
bool | ShowVertexColorsByList (SizeTArray const &in_vertices, Shell::Component in_apply_to, MaterialTypeArray &out_types, RGBColorArray &out_rgb_colors, RGBAColorArray &out_rgba_colors, FloatArray &out_indices) const |
bool | ShowVertexColorsByRange (size_t in_start, size_t in_count, Shell::Component in_apply_to, MaterialTypeArray &out_types, RGBColorArray &out_rgb_colors, RGBAColorArray &out_rgba_colors, FloatArray &out_indices) const |
bool | ShowVertexNormals (BoolArray &out_validities, VectorArray &out_normals) const |
bool | ShowVertexNormalsByList (SizeTArray const &in_vertices, BoolArray &out_validities, VectorArray &out_normals) const |
bool | ShowVertexNormalsByRange (size_t in_start, size_t in_count, BoolArray &out_validities, VectorArray &out_normals) const |
bool | ShowVertexParameters (BoolArray &out_validities, FloatArray &out_params) const |
bool | ShowVertexParameters (BoolArray &out_validities, FloatArray &out_params, size_t &out_param_width) const |
bool | ShowVertexParametersByList (SizeTArray const &in_vertices, BoolArray &out_validities, FloatArray &out_params) const |
bool | ShowVertexParametersByList (SizeTArray const &in_vertices, BoolArray &out_validities, FloatArray &out_params, size_t &out_param_width) const |
bool | ShowVertexParametersByRange (size_t in_start, size_t in_count, BoolArray &out_validities, FloatArray &out_params) const |
bool | ShowVertexParametersByRange (size_t in_start, size_t in_count, BoolArray &out_validities, FloatArray &out_params, size_t &out_param_width) const |
bool | ShowVertexVisibilities (BoolArray &out_validities, BoolArray &out_visibilities) const |
bool | ShowVertexVisibilitiesByList (SizeTArray const &in_vertices, BoolArray &out_validities, BoolArray &out_visibilities) const |
bool | ShowVertexVisibilitiesByRange (size_t in_start, size_t in_count, BoolArray &out_validities, BoolArray &out_visibilities) const |
ShellKit & | UnsetAllUserData () |
ShellKit & | UnsetEverything () |
ShellKit & | UnsetFaceColors () |
ShellKit & | UnsetFaceColorsByList (SizeTArray const &in_faces) |
ShellKit & | UnsetFaceColorsByRange (size_t in_start, size_t in_count) |
ShellKit & | UnsetFaceEverything () |
ShellKit & | UnsetFacelist () |
ShellKit & | UnsetFaceNormals () |
ShellKit & | UnsetFaceNormalsByList (SizeTArray const &in_vertices) |
ShellKit & | UnsetFaceNormalsByRange (size_t in_start, size_t in_count) |
ShellKit & | UnsetFaceVisibilities () |
ShellKit & | UnsetFaceVisibilitiesByList (SizeTArray const &in_vertices) |
ShellKit & | UnsetFaceVisibilitiesByRange (size_t in_start, size_t in_count) |
ShellKit & | UnsetMaterialMapping () |
ShellKit & | UnsetPoints () |
ShellKit & | UnsetPriority () |
ShellKit & | UnsetTristrips () |
ShellKit & | UnsetUserData (intptr_t in_index) |
ShellKit & | UnsetUserData (size_t in_count, intptr_t const in_indices[]) |
ShellKit & | UnsetUserData (IntPtrTArray const &in_indices) |
ShellKit & | UnsetVertexColors () |
ShellKit & | UnsetVertexColors (Shell::Component in_apply_to) |
ShellKit & | UnsetVertexColorsByList (SizeTArray const &in_vertices) |
ShellKit & | UnsetVertexColorsByList (SizeTArray const &in_vertices, Shell::Component in_apply_to) |
ShellKit & | UnsetVertexColorsByRange (size_t in_start, size_t in_count) |
ShellKit & | UnsetVertexColorsByRange (size_t in_start, size_t in_count, Shell::Component in_apply_to) |
ShellKit & | UnsetVertexEverything () |
ShellKit & | UnsetVertexNormals () |
ShellKit & | UnsetVertexNormalsByList (SizeTArray const &in_vertices) |
ShellKit & | UnsetVertexNormalsByRange (size_t in_start, size_t in_count) |
ShellKit & | UnsetVertexParameters () |
ShellKit & | UnsetVertexParametersByList (SizeTArray const &in_vertices) |
ShellKit & | UnsetVertexParametersByRange (size_t in_start, size_t in_count) |
ShellKit & | UnsetVertexVisibilities () |
ShellKit & | UnsetVertexVisibilitiesByList (SizeTArray const &in_vertices) |
ShellKit & | UnsetVertexVisibilitiesByRange (size_t in_start, size_t in_count) |
![]() | |
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
Constructor & Destructor Documentation
HPS::ShellKit::ShellKit | ( | ) |
The default constructor creates an empty ShellKit object.
HPS::ShellKit::ShellKit | ( | ShellKit const & | in_kit | ) |
HPS::ShellKit::ShellKit | ( | ShellKit && | in_that | ) |
Member Function Documentation
void HPS::ShellKit::ComputeRelation | ( | PointArray const & | in_points, |
ShellRelationOptionsKit const & | in_options, | ||
ShellRelationResultsKit & | out_results | ||
) | const |
Computes the relation of a collection of points to this shell, subject to the specified options.
- Parameters
-
in_points An array of points to test against this shell. in_options The options to use when performing the relation test. out_results The results of the relation test.
void HPS::ShellKit::ComputeRelation | ( | ShellKey const & | in_points_source, |
ShellRelationOptionsKit const & | in_options, | ||
ShellRelationResultsKit & | out_results | ||
) | const |
Computes the relation of a collection of points to this shell, subject to the specified options.
- Parameters
-
in_points_source A shell whose points should be tested against this shell. in_options The options to use when performing the relation test. out_results The results of the relation test.
void HPS::ShellKit::ComputeRelation | ( | ShellKit const & | in_points_source, |
ShellRelationOptionsKit const & | in_options, | ||
ShellRelationResultsKit & | out_results | ||
) | const |
Computes the relation of a collection of points to this shell, subject to the specified options.
- Parameters
-
in_points_source A shell whose points should be tested against this shell. in_options The options to use when performing the relation test. out_results The results of the relation test.
void HPS::ShellKit::Consume | ( | ShellKit & | in_kit | ) |
ShellKit& HPS::ShellKit::EditFacelistByDeletion | ( | size_t | in_offset, |
size_t | in_count | ||
) |
Removes faces from the face list for this ShellKit. This will not affect the points referenced by the removed faces, however any face attributes on the removed faces will be lost.
- Parameters
-
in_offset The offset into the faces for the shell at which to start removing faces. This value must be such that in_offset<face_count for deletion to succeed. This is not an offset into the raw face list, but is relative to the actual face count for the shell. in_count The number of faces to remove from the face list for the shell. This value must be such that in_offset+in_count<=face_count for the deletion to succeed.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::EditFacelistByInsertion | ( | size_t | in_offset, |
size_t | in_count, | ||
int const | in_facelist[] | ||
) |
Adds faces to the face list for this ShellKit.
- Parameters
-
in_offset The offset into the faces for the shell at which to insert faces. This value must be such that in_offset<face_count for insertion to succeed. This is not an offset into the raw face list, but is relative to the actual face count for the shell. in_count Size of the following array. in_facelist The faces (using the standard face-list encoding) to insert into the face list at the specified offset.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::EditFacelistByInsertion | ( | size_t | in_offset, |
IntArray const & | in_facelist | ||
) |
Adds faces to the face list for this ShellKit.
- Parameters
-
in_offset The offset into the faces for the shell at which to insert faces. This value must be such that in_offset<face_count for insertion to succeed. This is not an offset into the raw face list, but is relative to the actual face count for the shell. in_facelist The faces (using the standard face-list encoding) to insert into the face list at the specified offset.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::EditFacelistByReplacement | ( | size_t | in_offset, |
size_t | in_count, | ||
int const | in_facelist[] | ||
) |
Replaces faces in the face list for this ShellKit.
- Parameters
-
in_offset The offset into the faces for the shell at which to start replacing faces. This value must be such that in_offset<face_count for replacement to succeed. This is not an offset into the raw face list, but is relative to the actual face count for the shell. in_count Size of the following array. in_facelist The faces (using the standard face-list encoding) to use to replace those in the face list at the specified offset. The number of replacement faces must be such that in_offset+replacement_face_count<=face_count. This does not mean that the face list length must be the same, i.e., faces can use different numbers of vertices than previously, but rather is a limit on the number of faces encoded in the face list.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::EditFacelistByReplacement | ( | size_t | in_offset, |
IntArray const & | in_facelist | ||
) |
Replaces faces in the face list for this ShellKit.
- Parameters
-
in_offset The offset into the faces for the shell at which to start replacing faces. This value must be such that in_offset<face_count for replacement to succeed. This is not an offset into the raw face list, but is relative to the actual face count for the shell. in_facelist The faces (using the standard face-list encoding) to use to replace those in the face list at the specified offset. The number of replacement faces must be such that in_offset+replacement_face_count<=face_count. This does not mean that the face list length must be the same, i.e., faces can use different numbers of vertices than previously, but rather is a limit on the number of faces encoded in the face list.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::EditPointsByDeletion | ( | size_t | in_offset, |
size_t | in_count | ||
) |
Removes points from the point list for this ShellKit. Any existing faces which reference points which are being deleted will be removed. Additionally, any vertex attributes on the deleted vertices, i.e., colors, normals, parameters, and visibilities, will be removed. The face list will also be updated to reflect the new vertex offsets caused by removing elements from the point list.
- Parameters
-
in_offset The offset into the point list for the shell at which to start removing points. This value must be such that in_offset<point_count for deletion to succeed. in_count The number of points to delete from the point list for the shell. This value must be such that in_offset+in_count<=point_count for the deletion to succeed.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::EditPointsByInsertion | ( | size_t | in_offset, |
size_t | in_count, | ||
Point const | in_points[] | ||
) |
Adds points to the point list for this ShellKit. No existing faces will reference these points, i.e., the face list will be updated to reference the original vertices in their new positions. Addtionally, no vertex attributes will apply to these points, i.e., the vertex attributes will only be set on those points which had them prior to the insertion.
- Parameters
-
in_offset The offset into the point list for the shell at which to insert points. This value must be such that in_offset<point_count for insertion to succeed. in_count Size of the following array. in_points The points to insert into the point list at the specified offset.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::EditPointsByInsertion | ( | size_t | in_offset, |
PointArray const & | in_points | ||
) |
Adds points to the point list for this ShellKit. No existing faces will reference these points, i.e., the face list will be updated to reference the original vertices in their new positions. Addtionally, no vertex attributes will apply to these points, i.e., the vertex attributes will only be set on those points which had them prior to the insertion.
- Parameters
-
in_offset The offset into the point list for the shell at which to insert points. This value must be such that in_offset<point_count for insertion to succeed. in_points The points to insert into the point list at the specified offset.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::EditPointsByReplacement | ( | size_t | in_offset, |
size_t | in_count, | ||
Point const | in_points[] | ||
) |
Replaces points in the point list for this ShellKit. These points will replace those already referenced by any faces and will inherit any attributes the points being replaced had.
- Parameters
-
in_offset The offset into the point list for the shell at which to start replacing points. This value must be such that in_offset<point_count for replacement to succeed. in_count Size of the following array. This value must be such that in_offset+in_count<=point_count for the replacement to succeed. in_points The points to use to replace those in the point list at the specified offset.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::EditPointsByReplacement | ( | size_t | in_offset, |
PointArray const & | in_points | ||
) |
Replaces points in the point list for this ShellKit. These points will replace those already referenced by any faces and will inherit any attributes the points being replaced had.
- Parameters
-
in_offset The offset into the point list for the shell at which to start replacing points. This value must be such that in_offset<point_count for replacement to succeed. in_points The points to use to replace those in the point list at the specified offset. This size of the array must be such that in_offset+in_points.size()<=point_count for the replacement to succeed.
- Returns
- A reference to this ShellKit.
|
virtual |
Indicates whether this ShellKit has any values set on it.
- Returns
- true if no values are set on this ShellKit, false otherwise.
Reimplemented from HPS::Object.
bool HPS::ShellKit::Equals | ( | ShellKit const & | in_kit | ) | const |
size_t HPS::ShellKit::GetFaceCount | ( | ) | const |
Retrieves the number of faces in this shell. Note that this is different than the length of the face list
- Returns
- The number of faces in this shell.
size_t HPS::ShellKit::GetPointCount | ( | ) | const |
Retrieves the number of points in this shell.
- Returns
- The number of points in this shell.
|
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::Object.
bool HPS::ShellKit::operator!= | ( | ShellKit const & | in_kit | ) | const |
bool HPS::ShellKit::operator== | ( | ShellKit const & | in_kit | ) | const |
void HPS::ShellKit::Optimize | ( | ShellOptimizationOptionsKit const & | in_shell_optimization_kit | ) |
Optimizes the shell using the parameters set in a ShellOptimizationOptionsKit
- Parameters
-
in_shell_optimization_options_kit The kit containing the optimization options to use.
void HPS::ShellKit::Set | ( | ShellKit const & | in_kit | ) |
ShellKit& HPS::ShellKit::SetFaceIndexColorsByList | ( | size_t | in_count, |
size_t const | in_faces[], | ||
float const | in_indices[] | ||
) |
Sets face material indices on a selection of arbitrary faces.
- Parameters
-
in_count Size of the following arrays. in_faces The indices of the faces on which to set the colors. in_indices The material indices to set on the faces.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetFaceIndexColorsByList | ( | SizeTArray const & | in_faces, |
FloatArray const & | in_indices | ||
) |
Sets face material indices on a selection of arbitrary faces. If the sizes of the face index and material index arrays are different, the smaller size will be used.
- Parameters
-
in_faces The indices of the faces on which to set the colors. in_indices The material indices to set on the faces.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetFaceIndexColorsByList | ( | size_t | in_count, |
size_t const | in_faces[], | ||
float | in_index | ||
) |
Sets a single material index on a selection of arbitrary faces.
- Parameters
-
in_count Size of the following array. in_faces The indices of the faces on which to set the color. in_index The material index to set on the faces.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetFaceIndexColorsByList | ( | SizeTArray const & | in_faces, |
float | in_index | ||
) |
Sets a single material index on a selection of arbitrary faces.
- Parameters
-
in_faces The indices of the faces on which to set the color. in_index The material index to set on the faces.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetFaceIndexColorsByRange | ( | size_t | in_start, |
size_t | in_count, | ||
float const | in_indices[] | ||
) |
Sets face material indices on a range of faces starting at the specified offset.
- Parameters
-
in_start The offset into the faces for this ShellKit at which to start setting colors. in_count Size of the following array. in_indices The material indices to set on the faces for this ShellKit.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetFaceIndexColorsByRange | ( | size_t | in_start, |
FloatArray const & | in_indices | ||
) |
ShellKit& HPS::ShellKit::SetFaceIndexColorsByRange | ( | size_t | in_start, |
size_t | in_count, | ||
float | in_index | ||
) |
Sets a single material index on a range of faces starting at the specified offset.
- Parameters
-
in_start The offset into the faces for this ShellKit at which to start setting the color. in_count The number of faces on which to set the color. in_index The material index to set on the faces for this ShellKit.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetFacelist | ( | IntArray const & | in_facelist | ) |
ShellKit& HPS::ShellKit::SetFacelist | ( | size_t | in_count, |
int const | in_facelist[] | ||
) |
ShellKit& HPS::ShellKit::SetFaceNormalsByList | ( | size_t | in_count, |
size_t const | in_faces[], | ||
Vector const | in_normals[] | ||
) |
Sets face normals on a selection of arbitrary faces.
- Parameters
-
in_count Size of the following arrays. in_faces The indices of the faces on which to set the normals. in_normals The normals to set on the faces.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetFaceNormalsByList | ( | SizeTArray const & | in_faces, |
VectorArray const & | in_normals | ||
) |
Sets face normals on a selection of arbitrary faces. If the sizes of the face index and normal arrays are different, the smaller size will be used.
- Parameters
-
in_faces The indices of the faces on which to set the normals. in_normals The normals to set on the faces.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetFaceNormalsByList | ( | size_t | in_count, |
size_t const | in_faces[], | ||
Vector const & | in_normal | ||
) |
Sets a single normal on a selection of arbitrary faces.
- Parameters
-
in_count Size of the following array. in_faces The indices of the faces on which to set the normal. in_normal The normal to set on the faces.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetFaceNormalsByList | ( | SizeTArray const & | in_faces, |
Vector const & | in_normal | ||
) |
Sets a single normal on a selection of arbitrary faces.
- Parameters
-
in_faces The indices of the faces on which to set the normal. in_normal The normal to set on the faces.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetFaceNormalsByRange | ( | size_t | in_start, |
size_t | in_count, | ||
Vector const | in_normals[] | ||
) |
Sets face normals on a range of faces starting at the specified offset.
- Parameters
-
in_start The offset into the faces for this ShellKit at which to start setting normals. in_count Size of the following array. in_normals The normals to set on the faces for this ShellKit.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetFaceNormalsByRange | ( | size_t | in_start, |
VectorArray const & | in_normals | ||
) |
ShellKit& HPS::ShellKit::SetFaceNormalsByRange | ( | size_t | in_start, |
size_t | in_count, | ||
Vector const & | in_normal | ||
) |
Sets a single normal on a range of faces starting at the specified offset.
- Parameters
-
in_start The offset into the faces for this ShellKit at which to start setting the normal. in_count The number of faces on which to set the normal. in_normal The normal to set on the faces for this ShellKit.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetFaceRGBColorsByList | ( | size_t | in_count, |
size_t const | in_faces[], | ||
RGBColor const | in_rgb_colors[] | ||
) |
Sets face RGB colors on a selection of arbitrary faces.
- Parameters
-
in_count Size of the following arrays. in_faces The indices of the faces on which to set the colors. in_rgb_colors The RGB colors to set on the faces.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetFaceRGBColorsByList | ( | SizeTArray const & | in_faces, |
RGBColorArray const & | in_rgb_colors | ||
) |
Sets face RGB colors on a selection of arbitrary faces. If the sizes of the face index array and the color array different, the smaller size will be used.
- Parameters
-
in_faces The indices of the faces on which to set the colors. in_rgb_colors The RGB colors to set on the faces.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetFaceRGBColorsByList | ( | size_t | in_count, |
size_t const | in_faces[], | ||
RGBColor const & | in_rgb_color | ||
) |
Sets a single RGB color on a selection of arbitrary faces.
- Parameters
-
in_count Size of the following array. in_faces The indices of the faces on which to set the color. in_rgb_color The RGB color to set on the faces.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetFaceRGBColorsByList | ( | SizeTArray const & | in_faces, |
RGBColor const & | in_rgb_color | ||
) |
Sets a single RGB color on a selection of arbitrary faces.
- Parameters
-
in_faces The indices of the faces on which to set the color. in_rgb_color The RGB color to set on the faces.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetFaceRGBColorsByRange | ( | size_t | in_start, |
size_t | in_count, | ||
RGBColor const | in_rgb_colors[] | ||
) |
Sets face RGB colors on a range of faces starting at the specified offset.
- Parameters
-
in_start The offset into the faces for this ShellKit at which to start setting colors. in_count Size of the following array. in_rgb_colors The RGB colors to set on the faces for this ShellKit.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetFaceRGBColorsByRange | ( | size_t | in_start, |
RGBColorArray const & | in_rgb_colors | ||
) |
ShellKit& HPS::ShellKit::SetFaceRGBColorsByRange | ( | size_t | in_start, |
size_t | in_count, | ||
RGBColor const & | in_rgb_color | ||
) |
Sets a single RGB color on a range of faces starting at the specified offset.
- Parameters
-
in_start The offset into the faces for this ShellKit at which to start setting the color. in_count The number of faces on which to set the color. in_rgb_color The RGB color to set on the faces for this ShellKit.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetFaceVisibilitiesByList | ( | size_t | in_count, |
size_t const | in_faces[], | ||
bool const | in_visibilities[] | ||
) |
Sets face visibilities on a selection of arbitrary faces.
- Parameters
-
in_count Size of the following arrays. in_faces The indices of the faces on which to set the visibilities. in_visibilities The visibilities to set on the faces.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetFaceVisibilitiesByList | ( | SizeTArray const & | in_faces, |
BoolArray const & | in_visibilities | ||
) |
Sets face visibilities on a selection of arbitrary faces. If the sizes of the face index and visibility arrays are different, the smaller size will be used.
- Parameters
-
in_faces The indices of the faces on which to set the visibilities. in_visibilities The visibilities to set on the faces.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetFaceVisibilitiesByList | ( | size_t | in_count, |
size_t const | in_faces[], | ||
bool | in_visibility | ||
) |
Sets a single visibility on a selection of arbitrary faces.
- Parameters
-
in_count Size of the following array. in_faces The indices of the faces on which to set the visibility. in_visibility The visibility to set on the faces.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetFaceVisibilitiesByList | ( | SizeTArray const & | in_faces, |
bool | in_visibility | ||
) |
Sets a single visibility on a selection of arbitrary faces.
- Parameters
-
in_faces The indices of the faces on which to set the visibility. in_visibility The visibility to set on the faces.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetFaceVisibilitiesByRange | ( | size_t | in_start, |
size_t | in_count, | ||
bool const | in_visibilities[] | ||
) |
Sets face visibilities on a range of faces starting at the specified offset.
- Parameters
-
in_start The offset into the faces for this ShellKit at which to start setting visibilities. in_count Size of the following array. in_visibilities The visibilities to set on the faces for this ShellKit.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetFaceVisibilitiesByRange | ( | size_t | in_start, |
BoolArray const & | in_visibilities | ||
) |
ShellKit& HPS::ShellKit::SetFaceVisibilitiesByRange | ( | size_t | in_start, |
size_t | in_count, | ||
bool | in_visibility | ||
) |
Sets a single visibility on a range of faces starting at the specified offset.
- Parameters
-
in_start The offset into the faces for this ShellKit at which to start setting the visibility. in_count The number of faces on which to set the visibility. in_visibility The visibility to set on the faces for this ShellKit.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetMaterialMapping | ( | MaterialMappingKit const & | in_kit | ) |
Sets the specified material mappings on this ShellKit. If this kit is used to insert a shell, only face, back face, cut edge, cut face, edge, and vertex materials will be set on the inserted shell. These material settings will be "global" for the shell, i.e., all types will get the material for that type. To get different materials for the same types, e.g., faces with different colors, it is necessary to use the per-vertex or per-face functions.
- Parameters
-
in_kit The material mappings to set on this ShellKit.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetPoints | ( | PointArray const & | in_points | ) |
ShellKit& HPS::ShellKit::SetPriority | ( | int | in_priority | ) |
Assigns a specific drawing priority value to the ShellKit. 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()
ShellKit& HPS::ShellKit::SetTristrips | ( | IntArray const & | in_tristrips | ) |
ShellKit& HPS::ShellKit::SetTristrips | ( | size_t | in_count, |
int const | in_tristrips[] | ||
) |
ShellKit& HPS::ShellKit::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.
ShellKit& HPS::ShellKit::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.
ShellKit& HPS::ShellKit::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.
ShellKit& HPS::ShellKit::SetVertexIndexColorsByList | ( | size_t | in_count, |
size_t const | in_vertices[], | ||
float const | in_indices[], | ||
Shell::Component | in_apply_to = Shell::Component::Faces |
||
) |
Sets vertex material indices on a selection of arbitrary vertices which apply to the specified shell 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 shell component the colors should apply to. Defaults to Shell::Component::Faces.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetVertexIndexColorsByList | ( | SizeTArray const & | in_vertices, |
FloatArray const & | in_indices, | ||
Shell::Component | in_apply_to = Shell::Component::Faces |
||
) |
Sets vertex material indices on a selection of arbitrary vertices which apply to the specified shell 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 shell component the colors should apply to. Defaults to Shell::Component::Faces.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetVertexIndexColorsByList | ( | size_t | in_count, |
size_t const | in_vertices[], | ||
float | in_index, | ||
Shell::Component | in_apply_to = Shell::Component::Faces |
||
) |
Sets a single material index on a selection of arbitrary vertices which apply to the specified shell 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 shell component the colors should apply to. Defaults to Shell::Component::Faces.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetVertexIndexColorsByList | ( | SizeTArray const & | in_vertices, |
float | in_index, | ||
Shell::Component | in_apply_to = Shell::Component::Faces |
||
) |
Sets a single material index on a selection of arbitrary vertices which apply to the specified shell 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 shell component the colors should apply to. Defaults to Shell::Component::Faces.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetVertexIndexColorsByRange | ( | size_t | in_start, |
size_t | in_count, | ||
float const | in_indices[], | ||
Shell::Component | in_apply_to = Shell::Component::Faces |
||
) |
Sets vertex material indices on a range of vertices starting at the specified offset which apply to the specified shell component.
- Parameters
-
in_start The offset into the vertices for this ShellKit 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 ShellKit. in_apply_to The shell component the colors should apply to. Defaults to Shell::Component::Faces.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetVertexIndexColorsByRange | ( | size_t | in_start, |
FloatArray const & | in_indices, | ||
Shell::Component | in_apply_to = Shell::Component::Faces |
||
) |
Sets vertex material indices on a range of vertices starting at the specified offset which apply to the specified shell component.
- Parameters
-
in_start The offset into the vertices for this ShellKit at which to start setting colors. in_indices The material indices to set on the vertices for this ShellKit. in_apply_to The shell component the colors should apply to. Defaults to Shell::Component::Faces.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetVertexIndexColorsByRange | ( | size_t | in_start, |
size_t | in_count, | ||
float | in_index, | ||
Shell::Component | in_apply_to = Shell::Component::Faces |
||
) |
Sets a single material index on a range of vertices starting at the specified offset which apply to the specified shell component.
- Parameters
-
in_start The offset into the vertices for this ShellKit 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 ShellKit. in_apply_to The shell component the colors should apply to. Defaults to Shell::Component::Faces.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetVertexNormalsByList | ( | size_t | in_count, |
size_t const | in_vertices[], | ||
Vector const | in_normals[] | ||
) |
Sets vertex normals on a selection of arbitrary vertices.
- Parameters
-
in_count Size of the following arrays. in_vertices The indices of the vertices on which to set the normals. in_normals The normals to set on the vertices.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetVertexNormalsByList | ( | SizeTArray const & | in_vertices, |
VectorArray const & | in_normals | ||
) |
Sets vertex normals on a selection of arbitrary vertices. If the sizes of the vertex index and normal arrays are different, the smaller size will be used.
- Parameters
-
in_vertices The indices of the vertices on which to set the normals. in_normals The normals to set on the vertices.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetVertexNormalsByList | ( | size_t | in_count, |
size_t const | in_vertices[], | ||
Vector const & | in_normal | ||
) |
Sets a single normal on a selection of arbitrary vertices.
- Parameters
-
in_count Size of the following array. in_vertices The indices of the vertices on which to set the normal. in_normal The normal to set on the vertices.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetVertexNormalsByList | ( | SizeTArray const & | in_vertices, |
Vector const & | in_normal | ||
) |
Sets a single normal on a selection of arbitrary vertices.
- Parameters
-
in_vertices The indices of the vertices on which to set the normal. in_normal The normal to set on the vertices.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetVertexNormalsByRange | ( | size_t | in_start, |
size_t | in_count, | ||
Vector const | in_normals[] | ||
) |
Sets vertex normals on a range of vertices starting at the specified offset.
- Parameters
-
in_start The offset into the vertices for this ShellKit at which to start setting normals. in_count Size of the following array. in_normals The normals to set on the vertices for this ShellKit.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetVertexNormalsByRange | ( | size_t | in_start, |
VectorArray const & | in_normals | ||
) |
ShellKit& HPS::ShellKit::SetVertexNormalsByRange | ( | size_t | in_start, |
size_t | in_count, | ||
Vector const & | in_normal | ||
) |
Sets a single normal on a range of vertices starting at the specified offset.
- Parameters
-
in_start The offset into the vertices for this ShellKit at which to start setting the normal. in_count The number of vertices on which to set the normal. in_normal The normal to set on the vertices for this ShellKit.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetVertexParametersByList | ( | size_t | in_vertex_count, |
size_t const | in_vertices[], | ||
size_t | in_param_count, | ||
float const | in_params[], | ||
size_t | in_param_width = 2 |
||
) |
Sets texture parameters on a selection of arbitrary vertices. If the sizes of the vertex index array and the texture paramter array (divided by the parameter width) are different, the smaller size will be used.
- Parameters
-
in_vertex_count Size of the following array. in_vertices The indices of the vertices on which to set the texture parameters. in_param_count Size of the following array. This should be divisible by the parameter width, if it is not, some parameters will get ignored. in_params The texture parameters to set on the vertices for this ShellKit. in_param_width The number of texture parameters per vertex. Defaults to 2.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetVertexParametersByList | ( | SizeTArray const & | in_vertices, |
FloatArray const & | in_params, | ||
size_t | in_param_width = 2 |
||
) |
Sets texture parameters on a selection of arbitrary vertices. If the sizes of the vertex index array and the texture paramter array (divided by the parameter width) are different, the smaller size will be used.
- Parameters
-
in_vertices The indices of the vertices on which to set the texture parameters. in_params The texture parameters to set on the vertices for this ShellKit. The size of the array should be divisible by the parameter width, if it is not, some parameters will get ignored. in_param_width The number of texture parameters per vertex. Defaults to 2.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetVertexParametersByRange | ( | size_t | in_start, |
size_t | in_param_count, | ||
float const | in_params[], | ||
size_t | in_param_width = 2 |
||
) |
Sets texture parameters on a range of vertices starting at the specified offset.
- Parameters
-
in_start The offset into the vertices for this ShellKit at which to start setting texture parameters. in_param_count Size of the following array. This should be divisible by the parameter width, if it is not, some parameters will get ignored. in_params The texture parameters to set on the vertices for this ShellKit. in_param_width The number of texture parameters per vertex. Defaults to 2.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetVertexParametersByRange | ( | size_t | in_start, |
FloatArray const & | in_params, | ||
size_t | in_param_width = 2 |
||
) |
Sets texture parameters on a range of vertices starting at the specified offset.
- Parameters
-
in_start The offset into the vertices for this ShellKit at which to start setting texture parameters. in_params The texture parameters to set on the vertices for this ShellKit. The size of the array should be divisible by the parameter width, if it is not, some parameters will get ignored. in_param_width The number of texture parameters per vertex. Defaults to 2.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetVertexRGBAColorsByList | ( | size_t | in_count, |
size_t const | in_vertices[], | ||
RGBAColor const | in_rgba_colors[], | ||
Shell::Component | in_apply_to = Shell::Component::Faces |
||
) |
Sets vertex RGBA colors on a selection of arbitrary vertices which apply to the specified shell component.
- Parameters
-
in_count Size of the following arrays. in_vertices The indices of the vertices on which to set the colors. in_rgba_colors The RGBA colors to set on the vertices. in_apply_to The shell component the colors should apply to. Defaults to Shell::Component::Faces.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetVertexRGBAColorsByList | ( | SizeTArray const & | in_vertices, |
RGBAColorArray const & | in_rgba_colors, | ||
Shell::Component | in_apply_to = Shell::Component::Faces |
||
) |
Sets vertex RGBA colors on a selection of arbitrary vertices which apply to the specified shell component. If the sizes of the vertex index array and color array are different, the smaller size will be used.
- Parameters
-
in_vertices The indices of the vertices on which to set the colors. in_rgba_colors The RGBA colors to set on the vertices. in_apply_to The shell component the colors should apply to. Defaults to Shell::Component::Faces.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetVertexRGBAColorsByList | ( | size_t | in_count, |
size_t const | in_vertices[], | ||
RGBAColor const & | in_rgba_color, | ||
Shell::Component | in_apply_to = Shell::Component::Faces |
||
) |
Sets a single RGBA color on a selection of arbitrary vertices which apply to the specified shell component.
- Parameters
-
in_count Size of the following array. in_vertices The indices of the vertices on which to set the color. in_rgba_color The RGBA color to set on the vertices. in_apply_to The shell component the colors should apply to. Defaults to Shell::Component::Faces.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetVertexRGBAColorsByList | ( | SizeTArray const & | in_vertices, |
RGBAColor const & | in_rgba_color, | ||
Shell::Component | in_apply_to = Shell::Component::Faces |
||
) |
Sets a single RGBA color on a selection of arbitrary vertices which apply to the specified shell component.
- Parameters
-
in_vertices The indices of the vertices on which to set the color. in_rgba_color The RGBA color to set on the vertices. in_apply_to The shell component the colors should apply to. Defaults to Shell::Component::Faces.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetVertexRGBAColorsByRange | ( | size_t | in_start, |
size_t | in_count, | ||
RGBAColor const | in_rgba_colors[], | ||
Shell::Component | in_apply_to = Shell::Component::Faces |
||
) |
Sets vertex RGBA colors on a range of vertices starting at the specified offset which apply to the specified shell component.
- Parameters
-
in_start The offset into the vertices for this ShellKit at which to start setting colors. in_count Size of the following array. in_rgba_colors The RGBA colors to set on the vertices for this ShellKit. in_apply_to The shell component the colors should apply to. Defaults to Shell::Component::Faces.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetVertexRGBAColorsByRange | ( | size_t | in_start, |
RGBAColorArray const & | in_rgba_colors, | ||
Shell::Component | in_apply_to = Shell::Component::Faces |
||
) |
Sets vertex RGBA colors on a range of vertices starting at the specified offset which apply to the specified shell component.
- Parameters
-
in_start The offset into the vertices for this ShellKit at which to start setting colors. in_rgba_colors The RGBA colors to set on the vertices for this ShellKit. in_apply_to The shell component the colors should apply to. Defaults to Shell::Component::Faces.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetVertexRGBAColorsByRange | ( | size_t | in_start, |
size_t | in_count, | ||
RGBAColor const & | in_rgba_color, | ||
Shell::Component | in_apply_to = Shell::Component::Faces |
||
) |
Sets a single RGBA color on a range of vertices starting at the specified offset which apply to the specified shell component.
- Parameters
-
in_start The offset into the vertices for this ShellKit at which to start setting the color. in_count The number of vertices on which to set the color. in_rgba_color The RGBA color to set on the vertices for this ShellKit. in_apply_to The shell component the colors should apply to. Defaults to Shell::Component::Faces.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetVertexRGBColorsByList | ( | size_t | in_count, |
size_t const | in_vertices[], | ||
RGBColor const | in_rgb_colors[], | ||
Shell::Component | in_apply_to = Shell::Component::Faces |
||
) |
Sets vertex RGB colors on a selection of arbitrary vertices which apply to the specified shell 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 shell component the colors should apply to. Defaults to Shell::Component::Faces.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetVertexRGBColorsByList | ( | SizeTArray const & | in_vertices, |
RGBColorArray const & | in_rgb_colors, | ||
Shell::Component | in_apply_to = Shell::Component::Faces |
||
) |
Sets vertex RGB colors on a selection of arbitrary vertices which apply to the specified shell 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 shell component the colors should apply to. Defaults to Shell::Component::Faces.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetVertexRGBColorsByList | ( | size_t | in_count, |
size_t const | in_vertices[], | ||
RGBColor const & | in_rgb_color, | ||
Shell::Component | in_apply_to = Shell::Component::Faces |
||
) |
Sets a single RGB color on a selection of arbitrary vertices which apply to the specified shell 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 shell component the colors should apply to. Defaults to Shell::Component::Faces.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetVertexRGBColorsByList | ( | SizeTArray const & | in_vertices, |
RGBColor const & | in_rgb_color, | ||
Shell::Component | in_apply_to = Shell::Component::Faces |
||
) |
Sets a single RGB color on a selection of arbitrary vertices which apply to the specified shell 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 shell component the colors should apply to. Defaults to Shell::Component::Faces.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetVertexRGBColorsByRange | ( | size_t | in_start, |
size_t | in_count, | ||
RGBColor const | in_rgb_colors[], | ||
Shell::Component | in_apply_to = Shell::Component::Faces |
||
) |
Sets vertex RGB colors on a range of vertices starting at the specified offset which apply to the specified shell component.
- Parameters
-
in_start The offset into the vertices for this ShellKit 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 ShellKit. in_apply_to The shell component the colors should apply to. Defaults to Shell::Component::Faces.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetVertexRGBColorsByRange | ( | size_t | in_start, |
RGBColorArray const & | in_rgb_colors, | ||
Shell::Component | in_apply_to = Shell::Component::Faces |
||
) |
Sets vertex RGB colors on a range of vertices starting at the specified offset which apply to the specified shell component.
- Parameters
-
in_start The offset into the vertices for this ShellKit at which to start setting colors. in_rgb_colors The RGB colors to set on the vertices for this ShellKit. in_apply_to The shell component the colors should apply to. Defaults to Shell::Component::Faces.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetVertexRGBColorsByRange | ( | size_t | in_start, |
size_t | in_count, | ||
RGBColor const & | in_rgb_color, | ||
Shell::Component | in_apply_to = Shell::Component::Faces |
||
) |
Sets a single RGB color on a range of vertices starting at the specified offset which apply to the specified shell component.
- Parameters
-
in_start The offset into the vertices for this ShellKit 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 ShellKit. in_apply_to The shell component the colors should apply to. Defaults to Shell::Component::Faces.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetVertexVisibilitiesByList | ( | size_t | in_count, |
size_t const | in_vertices[], | ||
bool const | in_visibilities[] | ||
) |
Sets vertex visibilities on a selection of arbitrary vertices.
- Parameters
-
in_count Size of the following arrays. in_vertices The indices of the vertices on which to set the visibilities. in_visibilities The visibilities to set on the vertices.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetVertexVisibilitiesByList | ( | SizeTArray const & | in_vertices, |
BoolArray const & | in_visibilities | ||
) |
Sets vertex visibilities on a selection of arbitrary vertices. If the sizes of the vertex index and visibility arrays are different, the smaller size will be used.
- Parameters
-
in_vertices The indices of the vertices on which to set the visibilities. in_visibilities The visibilities to set on the vertices.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetVertexVisibilitiesByList | ( | size_t | in_count, |
size_t const | in_vertices[], | ||
bool | in_visibility | ||
) |
Sets a single visibility on a selection of arbitrary vertices.
- Parameters
-
in_count Size of the following array. in_vertices The indices of the vertices on which to set the visibility. in_visibility The visibility to set on the vertices.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetVertexVisibilitiesByList | ( | SizeTArray const & | in_vertices, |
bool | in_visibility | ||
) |
Sets a single visibility on a selection of arbitrary vertices.
- Parameters
-
in_vertices The indices of the vertices on which to set the visibility. in_visibility The visibility to set on the vertices.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetVertexVisibilitiesByRange | ( | size_t | in_start, |
size_t | in_count, | ||
bool const | in_visibilities[] | ||
) |
Sets vertex visibilities on a range of vertices starting at the specified offset.
- Parameters
-
in_start The offset into the vertices for this ShellKit at which to start setting visibilities. in_count Size of the following array. in_visibilities The visibilities to set on the vertices for this ShellKit.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::SetVertexVisibilitiesByRange | ( | size_t | in_start, |
BoolArray const & | in_visibilities | ||
) |
ShellKit& HPS::ShellKit::SetVertexVisibilitiesByRange | ( | size_t | in_start, |
size_t | in_count, | ||
bool | in_visibility | ||
) |
Sets a single visibility on a range of vertices starting at the specified offset.
- Parameters
-
in_start The offset into the vertices for this ShellKit at which to start setting the visibility. in_count The number of vertices on which to set the visibility. in_visibility The visibility to set on the vertices for this ShellKit.
- Returns
- A reference to this ShellKit.
void HPS::ShellKit::Show | ( | ShellKit & | out_kit | ) | const |
bool HPS::ShellKit::ShowFaceColors | ( | MaterialTypeArray & | out_types, |
RGBColorArray & | out_rgb_colors, | ||
FloatArray & | out_indices | ||
) | const |
Shows all the face colors on this ShellKit.
- Parameters
-
out_types The types of face colors for each face. If a face does not have a face color set, the entry in this array will be Material::Type::None. out_rgb_colors The RGB colors for each face. out_rgb_colors[i] is only valid if out_types[i] is Material::Type::RGBColor. out_indices The material indices for each face. The out_indices[i] is only valid if out_types[i] is Material::Type::MaterialIndex.
- Returns
- true if any face had a face color set, false otherwise.
bool HPS::ShellKit::ShowFaceColorsByList | ( | SizeTArray const & | in_faces, |
MaterialTypeArray & | out_types, | ||
RGBColorArray & | out_rgb_colors, | ||
FloatArray & | out_indices | ||
) | const |
Shows the face colors on a selection of arbitrary faces. The order of the values in the ouput arrays is the same as the input face index array, i.e., the values of out_types[i], out_rgb_colors[i], and out_indices[i], correspond to the face at index in_faces[i].
- Parameters
-
in_faces The indices of the faces on which to show the colors. out_types The types of face colors for each face at the specified index. If a face at a specified index does not have a face color set, the entry in this array will be Material::Type::None. out_rgb_colors The RGB colors for each face 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 face at the specified index. The out_indices[i] is only valid if out_types[i] is Material::Type::MaterialIndex.
- Returns
- true if any specified face had a face color set, false otherwise.
bool HPS::ShellKit::ShowFaceColorsByRange | ( | size_t | in_start, |
size_t | in_count, | ||
MaterialTypeArray & | out_types, | ||
RGBColorArray & | out_rgb_colors, | ||
FloatArray & | out_indices | ||
) | const |
Shows the face colors on a range of faces starting at the specified offset.
- Parameters
-
in_start The offset into the faces for this ShellKit at which to start showing colors. in_count The number of colors to show. out_types The types of face colors for each face in the specified range. If a face in the specified range does not have a face color set, the entry in this array will be Material::Type::None. out_rgb_colors The RGB colors for each face 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 face in the specified range. The out_indices[i] is only valid if out_types[i] is Material::Type::MaterialIndex.
- Returns
- true if any face in the specified range had a face color set, false otherwise.
bool HPS::ShellKit::ShowFacelist | ( | IntArray & | out_facelist | ) | const |
bool HPS::ShellKit::ShowFaceNormals | ( | BoolArray & | out_validities, |
VectorArray & | out_normals | ||
) | const |
Shows the all face normals on this ShellKit.
- Parameters
-
out_validities The validities of the normals for each face. If a face had a normal set on it, the entry in this array will be true, otherwise it will be false. out_normals The face normals for each face. out_normals[i] is only valid if out_validities[i] is true.
- Returns
- true if any face had a face normal set, false otherwise.
bool HPS::ShellKit::ShowFaceNormalsByList | ( | SizeTArray const & | in_faces, |
BoolArray & | out_validities, | ||
VectorArray & | out_normals | ||
) | const |
Shows the face normals on a selection of arbitrary faces. The order of the values in the output arrays is the same as the input face index array, i.e., the values of out_validities[i] and out_normals[i] correspond to the face at index in_faces[i].
- Parameters
-
in_faces The indices of the faces on which to show the normals. out_validities The validities of the normals for each face at the specified index. If a face at a specified index had a normal set on it, the entry in this array will be true, otherwise it will be false. out_normals The face normals for each face at the specified index. out_normals[i] is only valid if out_validities[i] is true.
- Returns
- true if any specified face had a face normal set, false otherwise.
bool HPS::ShellKit::ShowFaceNormalsByRange | ( | size_t | in_start, |
size_t | in_count, | ||
BoolArray & | out_validities, | ||
VectorArray & | out_normals | ||
) | const |
Shows the face normals on a range of faces starting at the specified offset.
- Parameters
-
in_start The offset into the faces for this ShellKit at which to start showing normals. in_count The number of normals to show. out_validities The validities of the normals for each face in the specified range. If a face in the specified range had a normal set on it, the entry in this array will be true, otherwise it will be false. out_normals The face normals for each face in the specified range. out_normals[i] is only valid if out_validities[i] is true.
- Returns
- true if any face in the specified range had a face normal set, false otherwise.
bool HPS::ShellKit::ShowFaceVisibilities | ( | BoolArray & | out_validities, |
BoolArray & | out_visibilities | ||
) | const |
Shows all the face visibilities on this ShellKit.
- Parameters
-
out_validities The validities of the visibilities for each face. If a face had a visibility set on it, the entry in this array will be true, otherwise it will be false. out_visibilities The face visibilities for each face. out_visibilities[i] is only valid if out_validities[i] is true.
- Returns
- true if any face had a face visibility set, false otherwise.
bool HPS::ShellKit::ShowFaceVisibilitiesByList | ( | SizeTArray const & | in_faces, |
BoolArray & | out_validities, | ||
BoolArray & | out_visibilities | ||
) | const |
Shows the face visibilities on a selection of arbitrary faces. The order of the values in the output arrays is the same as the input face index array, i.e., the values of out_validities[i] and out_visibilities[i] correspond to the face at index in_faces[i].
- Parameters
-
in_faces The indices of the faces on which to show the normals. out_validities The validities of the normals for each face at the specified index. If a face at a specified index had a visibility set on it, the entry in this array will be true, otherwise it will be false. out_visibilities The face visibilities for each face at the specified index. out_visibilities[i] is only valid if out_validities[i] is true.
- Returns
- true if any specified face had a face visibility set, false otherwise.
bool HPS::ShellKit::ShowFaceVisibilitiesByRange | ( | size_t | in_start, |
size_t | in_count, | ||
BoolArray & | out_validities, | ||
BoolArray & | out_visibilities | ||
) | const |
Shows the face visibilities on a range of faces starting at the specified offset.
- Parameters
-
in_start The offset into the faces for this ShellKit at which to start showing visibilities. in_count The number of visibilities to show. out_validities The validities of the visibilities for each face in the specified range. If a face in the specified range had a visibility set on it, the entry in this array will be true, otherwise it will be false. out_visibilities The face visibilities for each face in the specified range. out_visibilities[i] is only valid if out_validities[i] is true.
- Returns
- true if any face in the specified range had a face visibility set, false otherwise.
bool HPS::ShellKit::ShowMaterialMapping | ( | MaterialMappingKit & | out_kit | ) | const |
bool HPS::ShellKit::ShowPoints | ( | PointArray & | out_points | ) | const |
bool HPS::ShellKit::ShowPointsByList | ( | SizeTArray const & | in_indices, |
PointArray & | out_points | ||
) | const |
bool HPS::ShellKit::ShowPointsByList | ( | size_t | in_count, |
size_t const | in_indices[], | ||
PointArray & | out_points | ||
) | const |
bool HPS::ShellKit::ShowPointsByRange | ( | size_t | in_start_index, |
size_t | in_count, | ||
PointArray & | out_points | ||
) | const |
bool HPS::ShellKit::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.
bool HPS::ShellKit::ShowTristrips | ( | IntArray & | out_tristrips | ) | const |
bool HPS::ShellKit::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.
bool HPS::ShellKit::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.
size_t HPS::ShellKit::ShowUserDataCount | ( | ) | const |
Get the number of user data indices set on this kit.
bool HPS::ShellKit::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.
bool HPS::ShellKit::ShowVertexColors | ( | Shell::Component | in_apply_to, |
MaterialTypeArray & | out_types, | ||
RGBColorArray & | out_rgb_colors, | ||
RGBAColorArray & | out_rgba_colors, | ||
FloatArray & | out_indices | ||
) | const |
Shows all the vertex colors on the specified shell component.
- Parameters
-
in_apply_to The shell 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 shell 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_rgba_colors The RGBA colors for each vertex. out_rgba_colors[i] is only valid if out_types[i] is Material::Type::RGBAColor. 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.
bool HPS::ShellKit::ShowVertexColorsByList | ( | SizeTArray const & | in_vertices, |
Shell::Component | in_apply_to, | ||
MaterialTypeArray & | out_types, | ||
RGBColorArray & | out_rgb_colors, | ||
RGBAColorArray & | out_rgba_colors, | ||
FloatArray & | out_indices | ||
) | const |
Shows the vertex colors on a selection of arbitrary vertices which apply to the specified shell 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 shell 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_rgba_colors The RGBA colors for each vertex at the specified index. out_rgba_colors[i] is only valid if out_types[i] is Material::Type::RGBAColor. 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.
bool HPS::ShellKit::ShowVertexColorsByRange | ( | size_t | in_start, |
size_t | in_count, | ||
Shell::Component | in_apply_to, | ||
MaterialTypeArray & | out_types, | ||
RGBColorArray & | out_rgb_colors, | ||
RGBAColorArray & | out_rgba_colors, | ||
FloatArray & | out_indices | ||
) | const |
Shows the vertex colors on a range of vertices starting at the specified offset which apply to the specified shell component.
- Parameters
-
in_start The offset into the vertices for this ShellKit at which to start showing colors. in_count The number of colors to show. in_apply_to The shell 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 shell 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_rgba_colors The RGBA colors for each vertex in the specified range. out_rgba_colors[i] is only valid if out_types[i] is Material::Type::RGBAColor. 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.
bool HPS::ShellKit::ShowVertexNormals | ( | BoolArray & | out_validities, |
VectorArray & | out_normals | ||
) | const |
Shows all the vertex normals on this ShellKit.
- Parameters
-
out_validities The validities of the normals for each vertexe. If a vertex had a normal set on it, the entry in this array will be true, otherwise it will be false. out_normals The vertex normals for each vertex. out_normals[i] is only valid if out_validities[i] is true.
- Returns
- true if any vertex normals were shown, false otherwise.
bool HPS::ShellKit::ShowVertexNormalsByList | ( | SizeTArray const & | in_vertices, |
BoolArray & | out_validities, | ||
VectorArray & | out_normals | ||
) | const |
Shows the vertex normals on a selection of arbitrary vertices. The order of the values in the output arrays is the same as the input vertex index array, i.e., the values of out_validities[i] and out_normals[i] correspond to the vertex at index in_vertices[i].
- Parameters
-
in_vertices The indices of the vertices on which to show the normals. out_validities The validities of the normals for each vertex at the specified index. If a vertex at a specified index had a normal set on it, the entry in this array will be true, otherwise it will be false. out_normals The vertex normals for each vertex at the specified index. out_normals[i] is only valid if out_validities[i] is true.
- Returns
- true if any specified vertex had a vertex normal set, false otherwise.
bool HPS::ShellKit::ShowVertexNormalsByRange | ( | size_t | in_start, |
size_t | in_count, | ||
BoolArray & | out_validities, | ||
VectorArray & | out_normals | ||
) | const |
Shows the vertex normals on a range of vertices starting at the specified offset.
- Parameters
-
in_start The offset into the vertices for this ShellKit at which to start showing normals. in_count The number of normals to show. out_validities The validities of the normals for each vertex in the specified range. If a vertex in the specified range had a normal set on it, the entry in this array will be true, otherwise it will be false. out_normals The vertex normals for each vertex in the specified range. out_normals[i] is only valid if out_validities[i] is true.
- Returns
- true if any vertex in the specified range had a vertex normal set, false otherwise.
bool HPS::ShellKit::ShowVertexParameters | ( | BoolArray & | out_validities, |
FloatArray & | out_params | ||
) | const |
Shows the texture parameters on all of the vertices in this ShellKit. For this particular show function, the parameter width is returned implicitly and could be determined by out_params.size()/in_count.
- Parameters
-
out_validities The validities of the texture parameters for each vertex. If a vertex had a texture parameter set on it, the entry in this array will be true, otherwise it will be false. out_params The texture parameters for each vertex. (out_params[i],...,out_params[i+param_width-1]) are only valid if out_validities[i] is true.
- Returns
- true if any vertex had a texture parameter set, false otherwise.
bool HPS::ShellKit::ShowVertexParameters | ( | BoolArray & | out_validities, |
FloatArray & | out_params, | ||
size_t & | out_param_width | ||
) | const |
Shows the texture parameters on all of the vertices in this ShellKit.
- Parameters
-
out_validities The validities of the texture parameters for each vertex. If a vertex had a texture parameter set on it, the entry in this array will be true, otherwise it will be false. out_params The texture parameters for each vertex. (out_params[i],...,out_params[i+param_width-1]) are only valid if out_validities[i] is true. out_param_width The number of texture parameters per vertex.
- Returns
- true if any vertex had a texture parameter set, false otherwise.
bool HPS::ShellKit::ShowVertexParametersByList | ( | SizeTArray const & | in_vertices, |
BoolArray & | out_validities, | ||
FloatArray & | out_params | ||
) | const |
Shows the texture parameters on a selection of arbitrary vertices. For this particular show function, the parameter width is returned implicitly and could be determined by out_params.size()/in_vertices.size(). The order of the output arrays is the same as the input vertex index array, i.e., out_validities[i] and (out_params[i],...,out_params[i+param_width-1]) correspond to the vertex at index in_vertices[i].
- Parameters
-
in_vertices The indices of the vertices on which to show the texture parameters. out_validities The validities of the texture parameters for each vertex at the specified index. If a vertex at a specified index had a texture parameter set on it, the entry in this array will be true, otherwise it will be false. out_params The texture parameters for each vertex at the specified index. (out_params[i],...,out_params[i+param_width-1]) are only valid if out_validities[i] is true.
- Returns
- true if any specified vertex had a texture parameter set, false otherwise.
bool HPS::ShellKit::ShowVertexParametersByList | ( | SizeTArray const & | in_vertices, |
BoolArray & | out_validities, | ||
FloatArray & | out_params, | ||
size_t & | out_param_width | ||
) | const |
Shows the texture parameters on a selection of arbitrary vertices. The order of the output arrays is the same as the input vertex index array, i.e., out_validities[i] and (out_params[i],...,out_params[i+param_width-1]) correspond to the vertex at index in_vertices[i].
- Parameters
-
in_vertices The indices of the vertices on which to show the texture parameters. out_validities The validities of the texture parameters for each vertex at the specified index. If a vertex at a specified index had a texture parameter set on it, the entry in this array will be true, otherwise it will be false. out_params The texture parameters for each vertex at the specified index. (out_params[i],...,out_params[i+param_width-1]) are only valid if out_validities[i] is true. out_param_width The number of texture parameters per vertex.
- Returns
- true if any specified vertex had a texture parameter set, false otherwise.
bool HPS::ShellKit::ShowVertexParametersByRange | ( | size_t | in_start, |
size_t | in_count, | ||
BoolArray & | out_validities, | ||
FloatArray & | out_params | ||
) | const |
Shows the texture parameters on a range of vertices starting at the specified offset. For this particular show function, the parameter width is returned implicitly and could be determined by out_params.size()/in_count.
- Parameters
-
in_start The offset into the vertices for this ShellKit at which to start showing texture parameters. in_count The number of vertices for which to show the texture parameters. out_validities The validities of the texture parameters for each vertex in the specified range. If a vertex in the specified range had a texture parameter set on it, the entry in this array will be true, otherwise it will be false. out_params The texture parameters for each vertex in the specified range. (out_params[i],...,out_params[i+param_width-1]) are only valid if out_validities[i] is true.
- Returns
- true if any vertex in the specified range had a texture parameter set, false otherwise.
bool HPS::ShellKit::ShowVertexParametersByRange | ( | size_t | in_start, |
size_t | in_count, | ||
BoolArray & | out_validities, | ||
FloatArray & | out_params, | ||
size_t & | out_param_width | ||
) | const |
Shows the texture parameters on a range of vertices starting at the specified offset.
- Parameters
-
in_start The offset into the vertices for this ShellKit at which to start showing texture parameters. in_count The number of vertices for which to show the texture parameters. out_validities The validities of the texture parameters for each vertex in the specified range. If a vertex in the specified range had a texture parameter set on it, the entry in this array will be true, otherwise it will be false. out_params The texture parameters for each vertex in the specified range. (out_params[i],...,out_params[i+param_width-1]) are only valid if out_validities[i] is true. out_param_width The number of texture parameters per vertex.
- Returns
- true if any vertex in the specified range had a texture parameter set, false otherwise.
bool HPS::ShellKit::ShowVertexVisibilities | ( | BoolArray & | out_validities, |
BoolArray & | out_visibilities | ||
) | const |
Shows all the vertex visibilities on this ShellKit
- Parameters
-
out_validities The validities of the visibilities for each vertex. If a vertex had a visibility set on it, the entry in this array will be true, otherwise it will be false. out_visibilities The vertex visibilities for each vertex. out_visibilities[i] is only valid if out_validities[i] is true.
- Returns
- true if any vertex had a vertex visibility set, false otherwise.
bool HPS::ShellKit::ShowVertexVisibilitiesByList | ( | SizeTArray const & | in_vertices, |
BoolArray & | out_validities, | ||
BoolArray & | out_visibilities | ||
) | const |
Shows the vertex visibilities on a selection of arbitrary vertices. The order of the values in the output arrays is the same as the input vertex index array, i.e., the values of out_validities[i] and out_visibilities[i] correspond to the vertex at index in_vertices[i].
- Parameters
-
in_vertices The indices of the vertices on which to show the normals. out_validities The validities of the normals for each vertex at the specified index. If a vertex at a specified index had a visibility set on it, the entry in this array will be true, otherwise it will be false. out_visibilities The vertex visibilities for each vertex at the specified index. out_visibilities[i] is only valid if out_validities[i] is true.
- Returns
- true if any specified vertex had a vertex visibility set, false otherwise.
bool HPS::ShellKit::ShowVertexVisibilitiesByRange | ( | size_t | in_start, |
size_t | in_count, | ||
BoolArray & | out_validities, | ||
BoolArray & | out_visibilities | ||
) | const |
Shows the vertex visibilities on a range of vertices starting at the specified offset.
- Parameters
-
in_start The offset into the vertices for this ShellKit at which to start showing visibilities. in_count The number of visibilities to show. out_validities The validities of the visibilities for each vertex in the specified range. If a vertex in the specified range had a visibility set on it, the entry in this array will be true, otherwise it will be false. out_visibilities The vertex visibilities for each vertex in the specified range. out_visibilities[i] is only valid if out_validities[i] is true.
- Returns
- true if any vertex in the specified range had a vertex visibility set, false otherwise.
ShellKit& HPS::ShellKit::UnsetAllUserData | ( | ) |
Removes all user data from this kit.
- Returns
- A reference to this kit.
ShellKit& HPS::ShellKit::UnsetEverything | ( | ) |
ShellKit& HPS::ShellKit::UnsetFaceColors | ( | ) |
Removes all face colors (RGB colors or material indices).
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::UnsetFaceColorsByList | ( | SizeTArray const & | in_faces | ) |
Removes the face colors (RGB colors or material indices) on a selection of arbitrary vertices.
- Parameters
-
in_faces The indices of the faces on which to remove the colors.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::UnsetFaceColorsByRange | ( | size_t | in_start, |
size_t | in_count | ||
) |
Removes the specified range of face colors (RGB colors or material indices) starting at the specified offset.
- Parameters
-
in_start The offset into the faces for this ShellKit at which to start removing colors. in_count The number of face colors to remove for this ShellKit.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::UnsetFaceEverything | ( | ) |
ShellKit& HPS::ShellKit::UnsetFacelist | ( | ) |
ShellKit& HPS::ShellKit::UnsetFaceNormals | ( | ) |
Removes all face normals.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::UnsetFaceNormalsByList | ( | SizeTArray const & | in_vertices | ) |
Removes the face normals on a selection of arbitrary faces.
- Parameters
-
in_faces The indices of the faces on which to remove the normals.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::UnsetFaceNormalsByRange | ( | size_t | in_start, |
size_t | in_count | ||
) |
ShellKit& HPS::ShellKit::UnsetFaceVisibilities | ( | ) |
Removes all face visibilities.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::UnsetFaceVisibilitiesByList | ( | SizeTArray const & | in_vertices | ) |
Removes the face visibilities on a selection of arbitrary faces.
- Parameters
-
in_faces The indices of the faces on which to remove the visibilities.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::UnsetFaceVisibilitiesByRange | ( | size_t | in_start, |
size_t | in_count | ||
) |
ShellKit& HPS::ShellKit::UnsetMaterialMapping | ( | ) |
ShellKit& HPS::ShellKit::UnsetPoints | ( | ) |
ShellKit& HPS::ShellKit::UnsetPriority | ( | ) |
Removes a drawing priority setting.
- Returns
- A reference to this object.
ShellKit& HPS::ShellKit::UnsetTristrips | ( | ) |
ShellKit& HPS::ShellKit::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.
ShellKit& HPS::ShellKit::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.
ShellKit& HPS::ShellKit::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.
ShellKit& HPS::ShellKit::UnsetVertexColors | ( | ) |
Removes all vertex colors (RGB colors, RGBA colors, or material indices) for all shell components.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::UnsetVertexColors | ( | Shell::Component | in_apply_to | ) |
Removes all vertex colors (RGB colors, RGBA colors, or material indices) for the specified shell component.
- Parameters
-
in_apply_to The shell component for which to remove the colors.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::UnsetVertexColorsByList | ( | SizeTArray const & | in_vertices | ) |
Removes the vertex colors (RGB colors, RGBA colors, or material indices) for all shell 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 ShellKit.
ShellKit& HPS::ShellKit::UnsetVertexColorsByList | ( | SizeTArray const & | in_vertices, |
Shell::Component | in_apply_to | ||
) |
Removes the vertex colors (RGB colors, RGBA colors, or material indices) for the specified shell 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 shell component for which to remove the colors.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::UnsetVertexColorsByRange | ( | size_t | in_start, |
size_t | in_count | ||
) |
Removes the specified range of vertex colors (RGB colors, RGBA colors, or material indices) for all shell components starting at the specified offset.
- Parameters
-
in_start The offset into the vertices for this ShellKit at which to start removing colors. in_count The number of vertex colors to remove for this ShellKit.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::UnsetVertexColorsByRange | ( | size_t | in_start, |
size_t | in_count, | ||
Shell::Component | in_apply_to | ||
) |
Removes the specified range of vertex colors (RGB colors, RGBA colors, or material indices) for the specified shell component starting at the specified offset.
- Parameters
-
in_start The offset into the vertices for this ShellKit at which to start removing colors. in_count The number of vertex colors to remove for this ShellKit. in_apply_to The shell component for which to remove the colors.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::UnsetVertexEverything | ( | ) |
ShellKit& HPS::ShellKit::UnsetVertexNormals | ( | ) |
Removes all vertex normals.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::UnsetVertexNormalsByList | ( | SizeTArray const & | in_vertices | ) |
Removes the vertex normals on a selection of arbitrary vertices.
- Parameters
-
in_vertices The indices of the vertices on which to remove the normals.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::UnsetVertexNormalsByRange | ( | size_t | in_start, |
size_t | in_count | ||
) |
ShellKit& HPS::ShellKit::UnsetVertexParameters | ( | ) |
Removes all texture parameters.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::UnsetVertexParametersByList | ( | SizeTArray const & | in_vertices | ) |
Removes the texture parameters on a selection of arbitrary vertices.
- Parameters
-
in_vertices The indices of the vertices on which to remove the texture parameters.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::UnsetVertexParametersByRange | ( | size_t | in_start, |
size_t | in_count | ||
) |
Removes the specified range of texture parameters starting at the specified offset.
- Parameters
-
in_start The offset into the vertices for this ShellKit at which to start removing texture parameters. in_count The number of texture parameters to remove for this ShellKit.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::UnsetVertexVisibilities | ( | ) |
Removes all vertex visibilities.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::UnsetVertexVisibilitiesByList | ( | SizeTArray const & | in_vertices | ) |
Removes the vertex visibilities on a selection of arbitrary vertices.
- Parameters
-
in_vertices The indices of the vertices on which to remove the visibilities.
- Returns
- A reference to this ShellKit.
ShellKit& HPS::ShellKit::UnsetVertexVisibilitiesByRange | ( | size_t | in_start, |
size_t | in_count | ||
) |
The documentation for this class was generated from the following file:
- include/hps.h