HPS::ShellKey Class Reference

The ShellKey class is a smart pointer to a database object. More...

#include <hps.h>

Inheritance diagram for HPS::ShellKey:

Collaboration diagram for HPS::ShellKey:

Public Member Functions
	ShellKey ()
	The default constructor creates an uninitialized ShellKey object. More...
	ShellKey (Key const &in_that)
	This constructor creates an ShellKey object that shares the underlying smart-pointer of the source Key. More...
	ShellKey (ShellKey const &in_that)
	The copy constructor creates a ShellKey object that shares the underlying smart-pointer of the source ShellKey. More...
ShellKey &	operator= (ShellKey const &other)
	Associate this ShellKey with the same underlying impl as the source ShellKey. More...
	ShellKey (ShellKey &&in_that)
	The move constructor creates a ShellKey by transferring the underlying impl of the rvalue reference to this ShellKey thereby avoiding a copy and allocation. More...
ShellKey &	operator= (ShellKey &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this ShellKey thereby avoiding a copy. More...
	~ShellKey ()
HPS::Type	ObjectType () const
void	Consume (ShellKit &in_kit)
	Completely replaces all settings on this ShellKey with those set on the specified kit and resets the kit. More...
void	Set (ShellKit const &in_kit)
	Replace those settings on this ShellKey with those set on the specified kit. More...
void	Show (ShellKit &out_kit) const
	Copy the contents of this ShellKey into the specified kit. More...
size_t	GetPointCount () const
	Retrieves the number of points in this shell. More...
size_t	GetFaceCount () const
	Retrieves the number of faces in this shell. More...
ShellKey &	SetPoints (PointArray const &in_points)
	Replace the points on this ShellKey with the specified points. More...
ShellKey &	SetPoints (size_t in_count, Point const in_points [])
	Replace the points on this ShellKey with the specified points. More...
ShellKey &	SetFacelist (IntArray const &in_facelist)
	Replace the face list on this ShellKey with the specified face list. More...
ShellKey &	SetFacelist (size_t in_count, int const in_facelist [])
	Replace the face list on this ShellKey with the specified face list. More...
ShellKey &	SetTristrips (IntArray const &in_tristrips)
	Replace the face list on this ShellKey with the specified face list. More...
ShellKey &	SetTristrips (size_t in_count, int const in_tristrips [])
	Replace the face list on this ShellKey with the specified face list. More...
ShellKey &	SetMaterialMapping (MaterialMappingKit const &in_kit)
	Sets the specified material mappings on this ShellKey. More...
ShellKey &	UnsetPoints ()
	Removes the points for this ShellKey. More...
ShellKey &	UnsetFacelist ()
	Removes the face list for this ShellKey. More...
ShellKey &	UnsetTristrips ()
	Removes the tristrips list for this ShellKey. More...
ShellKey &	UnsetMaterialMapping ()
	Removes all material mappings on this ShellKey. More...
ShellKey &	UnsetEverything ()
	Removes all settings from this ShellKey. More...
bool	ShowPoints (PointArray &out_points) const
	Show the points for this ShellKey. More...
bool	ShowPointsByRange (size_t in_start_index, size_t in_count, PointArray &out_points) const
	Show a subset of the points for this ShellKey by range. More...
bool	ShowPointsByList (SizeTArray const &in_indices, PointArray &out_points) const
	Show a subset of the points for this ShellKey by list. More...
bool	ShowPointsByList (size_t in_count, size_t const in_indices[], PointArray &out_points) const
	Show a subset of the points for this ShellKey by list. More...
bool	ShowFacelist (IntArray &out_facelist) const
	Show the face list for this ShellKey. More...
bool	ShowTristrips (IntArray &out_tristrips) const
	Show the tristrips list for this ShellKey. More...
bool	ShowTristrips (IntArray &out_tristrips, IntArray &out_face_indices) const
	Show the tristrips list for this ShellKey. More...
bool	ShowMaterialMapping (MaterialMappingKit &out_kit) const
	Shows the material mappings set on this ShellKey. More...
ShellKey &	SetEdgeVisibilitiesByList (size_t in_count, size_t const in_vertices1[], size_t const in_vertices2[], bool const in_visibilities[])
	Sets edge visibilities on a selection of arbitrary edges. More...
ShellKey &	SetEdgeVisibilitiesByList (size_t in_count, size_t const in_vertices1[], size_t const in_vertices2[], bool in_visibility)
	Sets edge visibilities on a selection of arbitrary edges. More...
ShellKey &	SetEdgeVisibilitiesByList (SizeTArray const &in_vertices1, SizeTArray const &in_vertices2, bool in_visibility)
	Sets edge visibilities on a selection of arbitrary edges. More...
ShellKey &	SetEdgeVisibilitiesByList (SizeTArray const &in_vertices1, SizeTArray const &in_vertices2, BoolArray const &in_visibilities)
	Sets edge visibilities on a selection of arbitrary edges. More...
ShellKey &	SetEdgeIndexColorsByList (SizeTArray const &in_vertices1, SizeTArray const &in_vertices2, FloatArray const &in_indices)
	Sets edge material indices on a selection of arbitrary edges. More...
ShellKey &	SetEdgeIndexColorsByList (SizeTArray const &in_vertices1, SizeTArray const &in_vertices2, float in_index)
	Sets edge material indices on a selection of arbitrary edges. More...
ShellKey &	SetEdgeIndexColorsByList (size_t in_count, size_t const in_vertices1[], size_t const in_vertices2[], float const in_indices[])
	Sets edge material indices on a selection of arbitrary edges. More...
ShellKey &	SetEdgeIndexColorsByList (size_t in_count, size_t const in_vertices1[], size_t const in_vertices2[], float in_index)
	Sets edge material indices on a selection of arbitrary edges. More...
ShellKey &	SetEdgeRGBColorsByList (SizeTArray const &in_vertices1, SizeTArray const &in_vertices2, RGBColorArray const &in_rgb_colors)
	Sets edge colors on a selection of arbitrary edges. More...
ShellKey &	SetEdgeRGBColorsByList (SizeTArray const &in_vertices1, SizeTArray const &in_vertices2, RGBColor const &in_rgb_color)
	Sets edge colors on a selection of arbitrary edges. More...
ShellKey &	SetEdgeRGBColorsByList (size_t in_count, size_t const in_vertices1[], size_t const in_vertices2[], RGBColor const in_rgb_colors[])
	Sets edge colors on a selection of arbitrary edges. More...
ShellKey &	SetEdgeRGBColorsByList (size_t in_count, size_t const in_vertices1[], size_t const in_vertices2[], RGBColor const in_rgb_color)
	Sets edge colors on a selection of arbitrary edges. More...
bool	ShowEdgeColors (SizeTArray &out_vertices1, SizeTArray &out_vertices2, HPS::MaterialTypeArray &out_types, HPS::RGBColorArray &out_rgb_colors, HPS::FloatArray &out_indices)
	Sets edge colors on a selection of arbitrary edges. More...
bool	ShowEdgeColorsByList (SizeTArray const &in_vertices1, SizeTArray const &in_vertices2, HPS::MaterialTypeArray &out_types, HPS::RGBColorArray &out_rgb_colors, HPS::FloatArray &out_indices)
	Sets edge colors on a selection of arbitrary edges. More...
ShellKey &	UnsetEdgeColors ()
	Unsets edge colors on all edges. More...
ShellKey &	UnsetEdgeColorsByList (SizeTArray const &in_vertices1, SizeTArray const &in_vertices2)
	Unsets edge colors on a selection of arbitrary edges. More...
ShellKey &	UnsetEdgeColorsByList (size_t in_count, size_t const in_vertices1[], size_t const in_vertices2[])
	Unsets edge colors on a selection of arbitrary edges. More...
ShellKey &	UnsetEdgeVisibilities ()
	Removes all vertex visibilities. More...
ShellKey &	UnsetEdgeEverything ()
	Removes all edge settings (edge colors and edge visibilities) from this ShellKey. More...
ShellKey &	UnsetEdgeVisibilitiesByList (SizeTArray const &in_vertices1, SizeTArray const &in_vertices2)
	Unsets edge visibilities on a selection of arbitrary edges. More...
ShellKey &	UnsetEdgeVisibilitiesByList (size_t in_count, size_t const in_vertices1[], size_t const in_vertices2[])
	Unsets edge visibilities on a selection of arbitrary edges. More...
bool	ShowEdgeVisibilitiesByList (SizeTArray const &in_vertices1, SizeTArray const &in_vertices2, BoolArray &out_validities, BoolArray &out_visibilities) const
	Shows all the edge visibilities on this ShellKey. More...
ShellKey &	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. More...
ShellKey &	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. More...
ShellKey &	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. More...
ShellKey &	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. More...
ShellKey &	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. More...
ShellKey &	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. More...
ShellKey &	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. More...
ShellKey &	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. More...
ShellKey &	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. More...
ShellKey &	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. More...
ShellKey &	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. More...
ShellKey &	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. More...
ShellKey &	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. More...
ShellKey &	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. More...
ShellKey &	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. More...
ShellKey &	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. More...
ShellKey &	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. More...
ShellKey &	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. More...
ShellKey &	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. More...
ShellKey &	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. More...
ShellKey &	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. More...
ShellKey &	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. More...
ShellKey &	SetVertexNormalsByRange (size_t in_start, VectorArray const &in_normals)
	Sets vertex normals on a range of vertices starting at the specified offset. More...
ShellKey &	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. More...
ShellKey &	SetVertexNormalsByList (size_t in_count, size_t const in_vertices[], Vector const in_normals[])
	Sets vertex normals on a selection of arbitrary vertices. More...
ShellKey &	SetVertexNormalsByList (SizeTArray const &in_vertices, VectorArray const &in_normals)
	Sets vertex normals on a selection of arbitrary vertices. More...
ShellKey &	SetVertexNormalsByList (size_t in_count, size_t const in_vertices[], Vector const &in_normal)
	Sets a single normal on a selection of arbitrary vertices. More...
ShellKey &	SetVertexNormalsByList (SizeTArray const &in_vertices, Vector const &in_normal)
	Sets a single normal on a selection of arbitrary vertices. More...
ShellKey &	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. More...
ShellKey &	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. More...
ShellKey &	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. More...
ShellKey &	SetVertexParametersByList (SizeTArray const &in_vertices, FloatArray const &in_params, size_t in_param_width=2)
	Sets texture parameters on a selection of arbitrary vertices. More...
ShellKey &	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. More...
ShellKey &	SetVertexVisibilitiesByRange (size_t in_start, BoolArray const &in_visibilities)
	Sets vertex visibilities on a range of vertices starting at the specified offset. More...
ShellKey &	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. More...
ShellKey &	SetVertexVisibilitiesByList (size_t in_count, size_t const in_vertices[], bool const in_visibilities[])
	Sets vertex visibilities on a selection of arbitrary vertices. More...
ShellKey &	SetVertexVisibilitiesByList (SizeTArray const &in_vertices, BoolArray const &in_visibilities)
	Sets vertex visibilities on a selection of arbitrary vertices. More...
ShellKey &	SetVertexVisibilitiesByList (size_t in_count, size_t const in_vertices[], bool in_visibility)
	Sets a single visibility on a selection of arbitrary vertices. More...
ShellKey &	SetVertexVisibilitiesByList (SizeTArray const &in_vertices, bool in_visibility)
	Sets a single visibility on a selection of arbitrary vertices. More...
ShellKey &	UnsetVertexVisibilitiesByList (size_t in_count, size_t const in_vertices[])
	Removes the vertex visibilities on a selection of arbitrary vertices. More...
ShellKey &	UnsetVertexColorsByList (size_t in_count, size_t const in_vertices[])
	Removes the vertex visibilities on a selection of arbitrary vertices. More...
ShellKey &	UnsetVertexColorsByList (size_t in_count, size_t const in_vertices[], Shell::Component in_apply_to)
	Removes the vertex visibilities on a selection of arbitrary vertices. More...
ShellKey &	UnsetVertexColors ()
	Removes all vertex colors (RGB colors, RGBA colors, or material indices) for all shell components. More...
ShellKey &	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. More...
ShellKey &	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. More...
ShellKey &	UnsetVertexColors (Shell::Component in_apply_to)
	Removes all vertex colors (RGB colors, RGBA colors, or material indices) for the specified shell component. More...
ShellKey &	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. More...
ShellKey &	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. More...
ShellKey &	UnsetVertexNormals ()
	Removes all vertex normals. More...
ShellKey &	UnsetVertexNormalsByRange (size_t in_start, size_t in_count)
	Removes the specified range of vertex normals starting at the specified offset. More...
ShellKey &	UnsetVertexNormalsByList (SizeTArray const &in_vertices)
	Removes the vertex normals on a selection of arbitrary vertices. More...
ShellKey &	UnsetVertexParameters ()
	Removes all texture parameters. More...
ShellKey &	UnsetVertexParametersByRange (size_t in_start, size_t in_count)
	Removes the specified range of texture parameters starting at the specified offset. More...
ShellKey &	UnsetVertexParametersByList (SizeTArray const &in_vertices)
	Removes the texture parameters on a selection of arbitrary vertices. More...
ShellKey &	UnsetVertexVisibilities ()
	Removes all vertex visibilities. More...
ShellKey &	UnsetVertexVisibilitiesByRange (size_t in_start, size_t in_count)
	Removes the specified range of vertex visibilities starting at the specified offset. More...
ShellKey &	UnsetVertexVisibilitiesByList (SizeTArray const &in_vertices)
	Removes the vertex visibilities on a selection of arbitrary vertices. More...
ShellKey &	UnsetVertexEverything ()
	Removes all vertex settings (vertex colors, vertex normals, texture parameters, and vertex visibilities) from this ShellKey. More...
bool	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. More...
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
	Shows the vertex colors on a range of vertices starting at the specified offset which apply to the specified shell component. More...
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
	Shows the vertex colors on a selection of arbitrary vertices which apply to the specified shell component. More...
bool	ShowVertexNormals (BoolArray &out_validities, VectorArray &out_normals) const
	Shows all the vertex normals on this ShellKey. More...
bool	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. More...
bool	ShowVertexNormalsByList (SizeTArray const &in_vertices, BoolArray &out_validities, VectorArray &out_normals) const
	Shows the vertex normals on a selection of arbitrary vertices. More...
bool	ShowNetVertexNormals (VectorArray &out_normals) const
	Shows the all net vertex normals on this ShellKey. More...
bool	ShowNetVertexNormalsByRange (size_t in_start, size_t in_count, VectorArray &out_normals) const
	Shows the net vertex normals on a range of vertices starting at the specified offset. More...
bool	ShowVertexParameters (BoolArray &out_validities, FloatArray &out_params) const
	Shows the texture parameters for all of the vertices on this ShellKey. More...
bool	ShowVertexParameters (BoolArray &out_validities, FloatArray &out_params, size_t &out_param_width) const
	Shows the texture parameters for all of the vertices on this ShellKey. More...
bool	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. More...
bool	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. More...
bool	ShowVertexParametersByList (SizeTArray const &in_vertices, BoolArray &out_validities, FloatArray &out_params) const
	Shows the texture parameters on a selection of arbitrary vertices. More...
bool	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. More...
bool	ShowVertexVisibilities (BoolArray &out_validities, BoolArray &out_visibilities) const
	Shows all the vertex visibilities on this ShellKey. More...
bool	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. More...
bool	ShowVertexVisibilitiesByList (SizeTArray const &in_vertices, BoolArray &out_validities, BoolArray &out_visibilities) const
	Shows the vertex visibilities on a selection of arbitrary vertices. More...
ShellKey &	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. More...
ShellKey &	SetFaceRGBColorsByRange (size_t in_start, RGBColorArray const &in_rgb_colors)
	Sets face RGB colors on a range of faces starting at the specified offset. More...
ShellKey &	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. More...
ShellKey &	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. More...
ShellKey &	SetFaceRGBColorsByList (SizeTArray const &in_faces, RGBColorArray const &in_rgb_colors)
	Sets face RGB colors on a selection of arbitrary faces. More...
ShellKey &	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. More...
ShellKey &	SetFaceRGBColorsByList (SizeTArray const &in_faces, RGBColor const &in_rgb_color)
	Sets a single RGB color on a selection of arbitrary faces. More...
ShellKey &	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. More...
ShellKey &	SetFaceIndexColorsByRange (size_t in_start, FloatArray const &in_indices)
	Sets face material indices on a range of faces starting at the specified offset. More...
ShellKey &	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. More...
ShellKey &	SetFaceIndexColorsByList (size_t in_count, size_t const in_faces[], float const in_indices[])
	Sets face material indices on a selection of arbitrary faces. More...
ShellKey &	SetFaceIndexColorsByList (SizeTArray const &in_faces, FloatArray const &in_indices)
	Sets face material indices on a selection of arbitrary faces. More...
ShellKey &	SetFaceIndexColorsByList (size_t in_count, size_t const in_faces[], float in_index)
	Sets a single material index on a selection of arbitrary faces. More...
ShellKey &	SetFaceIndexColorsByList (SizeTArray const &in_faces, float in_index)
	Sets a single material index on a selection of arbitrary faces. More...
ShellKey &	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. More...
ShellKey &	SetFaceNormalsByRange (size_t in_start, VectorArray const &in_normals)
	Sets face normals on a range of faces starting at the specified offset. More...
ShellKey &	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. More...
ShellKey &	SetFaceNormalsByList (size_t in_count, size_t const in_faces[], Vector const in_normals[])
	Sets face normals on a selection of arbitrary faces. More...
ShellKey &	SetFaceNormalsByList (SizeTArray const &in_faces, VectorArray const &in_normals)
	Sets face normals on a selection of arbitrary faces. More...
ShellKey &	SetFaceNormalsByList (size_t in_count, size_t const in_faces[], Vector const &in_normal)
	Sets a single normal on a selection of arbitrary faces. More...
ShellKey &	SetFaceNormalsByList (SizeTArray const &in_faces, Vector const &in_normal)
	Sets a single normal on a selection of arbitrary faces. More...
ShellKey &	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. More...
ShellKey &	SetFaceVisibilitiesByRange (size_t in_start, BoolArray const &in_visibilities)
	Sets face visibilities on a range of faces starting at the specified offset. More...
ShellKey &	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. More...
ShellKey &	SetFaceVisibilitiesByList (size_t in_count, size_t const in_faces[], bool const in_visibilities[])
	Sets face visibilities on a selection of arbitrary faces. More...
ShellKey &	SetFaceVisibilitiesByList (SizeTArray const &in_faces, BoolArray const &in_visibilities)
	Sets face visibilities on a selection of arbitrary faces. More...
ShellKey &	SetFaceVisibilitiesByList (size_t in_count, size_t const in_faces[], bool in_visibility)
	Sets a single visibility on a selection of arbitrary faces. More...
ShellKey &	SetFaceVisibilitiesByList (SizeTArray const &in_faces, bool in_visibility)
	Sets a single visibility on a selection of arbitrary faces. More...
ShellKey &	UnsetFaceColors ()
	Removes all face colors (RGB colors or material indices). More...
ShellKey &	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. More...
ShellKey &	UnsetFaceColorsByList (SizeTArray const &in_vertices)
	Removes the face colors (RGB colors or material indices) on a selection of arbitrary vertices. More...
ShellKey &	UnsetFaceVisibilitiesByList (size_t in_count, size_t const in_faces[])
	Removes the face visibilities on a selection of arbitrary faces. More...
ShellKey &	UnsetFaceColorsByList (size_t in_count, size_t const in_faces[])
	Removes the face visibilities on a selection of arbitrary faces. More...
ShellKey &	UnsetFaceNormals ()
	Removes all face normals. More...
ShellKey &	UnsetFaceNormalsByRange (size_t in_start, size_t in_count)
	Removes the specified range of face normals starting at the specified offset. More...
ShellKey &	UnsetFaceNormalsByList (SizeTArray const &in_vertices)
	Removes the face normals on a selection of arbitrary faces. More...
ShellKey &	UnsetFaceVisibilities ()
	Removes all face visibilities. More...
ShellKey &	UnsetFaceVisibilitiesByRange (size_t in_start, size_t in_count)
	Removes the specified range of face visibilities starting at the specified offset. More...
ShellKey &	UnsetFaceVisibilitiesByList (SizeTArray const &in_vertices)
	Removes the face visibilities on a selection of arbitrary faces. More...
ShellKey &	UnsetFaceEverything ()
	Removes all face settings (face colors, face normals, and face visibilities) from this ShellKey. More...
bool	ShowFaceColors (MaterialTypeArray &out_types, RGBColorArray &out_rgb_colors, FloatArray &out_indices) const
	Shows the face colors on ShellKey. More...
bool	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. More...
bool	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. More...
bool	ShowFaceNormals (BoolArray &out_validities, VectorArray &out_normals) const
	Shows all the face normals for this ShellKey. More...
bool	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. More...
bool	ShowFaceNormalsByList (SizeTArray const &in_faces, BoolArray &out_validities, VectorArray &out_normals) const
	Shows the face normals on a selection of arbitrary faces. More...
bool	ShowNetFaceNormalsByRange (size_t in_start, size_t in_count, VectorArray &out_normals) const
	Shows the effective face normals on a range of faces starting at the specified offset. More...
bool	ShowNetFaceNormalsByList (SizeTArray const &in_faces, VectorArray &out_normals) const
	Shows the effective face normals on a selection of arbitrary faces. More...
bool	ShowFaceVisibilities (BoolArray &out_validities, BoolArray &out_visibilities) const
	Shows all the face visibilities on this ShellKey. More...
bool	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. More...
bool	ShowFaceVisibilitiesByList (SizeTArray const &in_faces, BoolArray &out_validities, BoolArray &out_visibilities) const
	Shows the face visibilities on a selection of arbitrary faces. More...
ShellKey &	EditPointsByInsertion (size_t in_offset, size_t in_count, Point const in_points[])
	Adds points to the point list for this ShellKey. More...
ShellKey &	EditPointsByInsertion (size_t in_offset, PointArray const &in_points)
	Adds points to the point list for this ShellKey. More...
ShellKey &	EditPointsByDeletion (size_t in_offset, size_t in_count)
	Removes points from the point list for this ShellKey. More...
ShellKey &	EditPointsByReplacement (size_t in_offset, size_t in_count, Point const in_points[])
	Replaces points in the point list for this ShellKey. More...
ShellKey &	EditPointsByReplacement (size_t in_offset, PointArray const &in_points)
	Replaces points in the point list for this ShellKey. More...
ShellKey &	EditFacelistByInsertion (size_t in_offset, size_t in_count, int const in_facelist[])
	Adds faces to the face list for this ShellKey. More...
ShellKey &	EditFacelistByInsertion (size_t in_offset, IntArray const &in_facelist)
	Adds faces to the face list for this ShellKey. More...
ShellKey &	EditFacelistByDeletion (size_t in_offset, size_t in_count)
	Removes faces from the face list for this ShellKey. More...
ShellKey &	EditFacelistByReplacement (size_t in_offset, size_t in_count, int const in_facelist[])
	Replaces faces in the face list for this ShellKey. More...
ShellKey &	EditFacelistByReplacement (size_t in_offset, IntArray const &in_facelist)
	Replaces faces in the face list for this ShellKey. More...
void	Optimize (ShellOptimizationOptionsKit const &in_shell_optimization_kit)
	Optimizes the shell using the parameters set in a ShellOptimizationOptionsKit. More...
void	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. More...
void	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. More...
void	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. More...
size_t	ShowReferrers (SegmentKeyArray &out_segments) const
	Shows the all the segments which contain references to this key. More...
size_t	ShowReferrers (ReferenceKeyArray &out_references) const
	Shows the all the references to this key. More...
GeometryKey &	SetPriority (int in_priority)
	Assigns a drawing priority value to the geometry. More...
GeometryKey &	UnsetPriority ()
	Removes the drawing priority setting. More...
bool	ShowPriority (int &out_priority) const
	Shows the drawing priority. More...
GeometryKey &	SetUserData (intptr_t in_index, size_t in_bytes, byte const in_data[])
	Sets user data on this key. More...
GeometryKey &	SetUserData (intptr_t in_index, ByteArray const &in_data)
	Sets user data on this key. More...
GeometryKey &	SetUserData (IntPtrTArray const &in_indices, ByteArrayArray const &in_data)
	Sets user data on this key. More...
GeometryKey &	UnsetUserData (intptr_t in_index)
	Removes the user data at the given index from this key. More...
GeometryKey &	UnsetUserData (size_t in_count, intptr_t const in_indices[])
	Removes the user data at the given indices from this key. More...
GeometryKey &	UnsetUserData (IntPtrTArray const &in_indices)
	Removes the user data at the given indices from this key. More...
GeometryKey &	UnsetAllUserData ()
	Removes all user data from this key. More...
size_t	ShowUserDataCount () const
	Get the number of user data indices set on this key. More...
bool	ShowUserDataIndices (IntPtrTArray &out_indices) const
	Shows the indices of all user data set on this key. More...
bool	ShowUserData (intptr_t in_index, ByteArray &out_data) const
	Shows the user data at a given index for this key. More...
bool	ShowUserData (IntPtrTArray &out_indices, ByteArrayArray &out_data) const
	Shows all user data for this key. More...
bool	ShowBounding (BoundingKit &out_kit) const
	Shows the bounding of this geometry. More...
bool	HasOwner () const
SegmentKey	Up () const
SegmentKey	Owner () const
void	Delete ()
	Removes the database object referred to by this key. More...
void	MoveTo (SegmentKey const &in_new_owner)
	Moves the database object referred to by this key into a new containing segment pointed to by in_new_owner. More...
Key	CopyTo (SegmentKey const &in_destination) const
	Copies the database object referred to by this key into a segment pointed to by in_destination. More...
virtual void	Assign (Key const &in_that)
	Share the underlying smart-pointer of the Key source. More...
bool	Equals (Key const &in_that) const
	Determines whether the database objects pointed to by this key and in_that are the same. More...
bool	operator!= (Key const &in_that) const
	Determines whether the database objects pointed to by this key and in_that are the same. More...
bool	operator== (Key const &in_that) const
	Determines whether the database objects pointed to by this key and in_that are the same. More...
size_t	GetHash () const
	Returns a hash code for the key. More...
virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...
virtual bool	Empty () const
	Indicates whether this object has any values set on it. More...
virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...
bool	HasType (HPS::Type in_mask) const
	This function indicates whether this Object has the given Type mask. More...
intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...
intptr_t	GetInstanceID () const
	Returns an identifier that can be used to identify which instance of a class an object is. More...

Static Public Member Functions
template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::ShellKey

Detailed Description

The ShellKey class is a smart pointer to a database object.

It is a handle to a shell created by SegmentKey::InsertShell.

Constructor & Destructor Documentation

ShellKey() [1/4]

HPS::ShellKey::ShellKey

(

)

The default constructor creates an uninitialized ShellKey object.

The Type() function will return Type::None.

ShellKey() [2/4]

HPS::ShellKey::ShellKey ( Key const &  in_that )

explicit

This constructor creates an ShellKey object that shares the underlying smart-pointer of the source Key.

The copy will only be successful if the source key is really an upcast of a shell key. Otherwise the copy will fail and the resulting ShellKey will be invalid.

Parameters

in_key

The source Key to copy.

ShellKey() [3/4]

HPS::ShellKey::ShellKey

(

ShellKey const &

in_that

)

The copy constructor creates a ShellKey object that shares the underlying smart-pointer of the source ShellKey.

Parameters

in_that

The source ShellKey to copy.

ShellKey() [4/4]

HPS::ShellKey::ShellKey

(

ShellKey &&

in_that

)

The move constructor creates a ShellKey by transferring the underlying impl of the rvalue reference to this ShellKey thereby avoiding a copy and allocation.

Parameters

in_that

An rvalue reference to a ShellKey to take the impl from.

~ShellKey()

HPS::ShellKey::~ShellKey

(

)

Member Function Documentation

Assign()

virtual void HPS::Key::Assign ( Key const &  in_that )

virtualinherited

Share the underlying smart-pointer of the Key source.

Parameters

in_that

The Key source of the assignment.

ClassID()

template<typename T >

static intptr_t HPS::Object::ClassID ( )

inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

ComputeRelation() [1/3]

void HPS::ShellKey::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.

ComputeRelation() [2/3]

void HPS::ShellKey::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.

ComputeRelation() [3/3]

void HPS::ShellKey::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.

Consume()

void HPS::ShellKey::Consume

(

ShellKit &

in_kit

)

Completely replaces all settings on this ShellKey with those set on the specified kit and resets the kit.

Parameters

in_kit

The kit from which to get the settings to replace on this ShellKey.

CopyTo()

Key HPS::Key::CopyTo ( SegmentKey const &  in_destination ) const

inherited

Copies the database object referred to by this key into a segment pointed to by in_destination.

Returns

The key of the new copy.

Delete()

void HPS::Key::Delete ( )

inherited

Removes the database object referred to by this key.

EditFacelistByDeletion()

ShellKey& HPS::ShellKey::EditFacelistByDeletion	(	size_t	in_offset,
		size_t	in_count
	)

Removes faces from the face list for this ShellKey.

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 ShellKey.

EditFacelistByInsertion() [1/2]

ShellKey& HPS::ShellKey::EditFacelistByInsertion	(	size_t	in_offset,
		size_t	in_count,
		int const	in_facelist[]
	)

Adds faces to the face list for this ShellKey.

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 ShellKey.

EditFacelistByInsertion() [2/2]

ShellKey& HPS::ShellKey::EditFacelistByInsertion	(	size_t	in_offset,
		IntArray const &	in_facelist
	)

Adds faces to the face list for this ShellKey.

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 ShellKey.

EditFacelistByReplacement() [1/2]

ShellKey& HPS::ShellKey::EditFacelistByReplacement	(	size_t	in_offset,
		size_t	in_count,
		int const	in_facelist[]
	)

Replaces faces in the face list for this ShellKey.

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 ShellKey.

EditFacelistByReplacement() [2/2]

ShellKey& HPS::ShellKey::EditFacelistByReplacement	(	size_t	in_offset,
		IntArray const &	in_facelist
	)

Replaces faces in the face list for this ShellKey.

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 ShellKey.

EditPointsByDeletion()

ShellKey& HPS::ShellKey::EditPointsByDeletion	(	size_t	in_offset,
		size_t	in_count
	)

Removes points from the point list for this ShellKey.

Any existing faces which reference points which are being deleted will be removed. Additionally, any vertex settings 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 ShellKey.

EditPointsByInsertion() [1/2]

ShellKey& HPS::ShellKey::EditPointsByInsertion	(	size_t	in_offset,
		size_t	in_count,
		Point const	in_points[]
	)

Adds points to the point list for this ShellKey.

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 ShellKey.

EditPointsByInsertion() [2/2]

ShellKey& HPS::ShellKey::EditPointsByInsertion	(	size_t	in_offset,
		PointArray const &	in_points
	)

Adds points to the point list for this ShellKey.

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 ShellKey.

EditPointsByReplacement() [1/2]

ShellKey& HPS::ShellKey::EditPointsByReplacement	(	size_t	in_offset,
		size_t	in_count,
		Point const	in_points[]
	)

Replaces points in the point list for this ShellKey.

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 ShellKey.

EditPointsByReplacement() [2/2]

ShellKey& HPS::ShellKey::EditPointsByReplacement	(	size_t	in_offset,
		PointArray const &	in_points
	)

Replaces points in the point list for this ShellKey.

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 ShellKey.

Empty()

virtual bool HPS::Object::Empty ( ) const

inlinevirtualinherited

Indicates whether this object has any values set on it.

Returns

true if no values are set on this object, false otherwise.

Reimplemented in HPS::STL::ImportResultsKit, HPS::STL::ImportOptionsKit, HPS::OBJ::ImportResultsKit, HPS::OBJ::ImportOptionsKit, HPS::Hardcopy::File::ExportOptionsKit, HPS::Stream::ExportOptionsKit, HPS::Stream::ImportResultsKit, HPS::Stream::ImportOptionsKit, HPS::PointCloud::ImportOptionsKit, HPS::PointCloud::ImportResultsKit, HPS::UpdateOptionsKit, HPS::HighlightSearchOptionsKit, HPS::HighlightOptionsKit, HPS::SelectionOptionsKit, HPS::SearchOptionsKit, HPS::CutGeometryGatheringOptionsKit, HPS::ShapeKit, HPS::ShaderKit, HPS::Shader::ImportOptionsKit, HPS::ImageKit, HPS::Image::ImportOptionsKit, HPS::Image::ExportOptionsKit, HPS::TextureOptionsKit, HPS::LinePatternKit, HPS::LinePatternParallelKit, HPS::LinePatternOptionsKit, HPS::GlyphKit, HPS::ApplicationWindowOptionsKit, HPS::OffScreenWindowOptionsKit, HPS::StandAloneWindowOptionsKit, HPS::GridKit, HPS::PolygonKit, HPS::MeshKit, HPS::ShellKit, HPS::ShellRelationResultsKit, HPS::ShellRelationOptionsKit, HPS::ShellOptimizationOptionsKit, HPS::TextKit, HPS::EllipticalArcKit, HPS::EllipseKit, HPS::TrimKit, HPS::NURBSSurfaceKit, HPS::NURBSCurveKit, HPS::SpotlightKit, HPS::InfiniteLineKit, HPS::CuttingSectionKit, HPS::CircularWedgeKit, HPS::CircularArcKit, HPS::CircleKit, HPS::SphereKit, HPS::CylinderKit, HPS::DistantLightKit, HPS::MarkerKit, HPS::LineKit, HPS::AttributeLockKit, HPS::FontInfoState, HPS::WindowInfoKit, HPS::DebuggingKit, HPS::SubwindowKit, HPS::ContourLineKit, HPS::VisualEffectsKit, HPS::TransformMaskKit, HPS::PostProcessEffectsKit, HPS::DrawingAttributeKit, HPS::HiddenLineAttributeKit, HPS::PerformanceKit, HPS::NURBSSurfaceAttributeKit, HPS::MaterialKit, HPS::MaterialMappingKit, HPS::MatrixKit, HPS::CurveAttributeKit, HPS::EdgeAttributeKit, HPS::LineAttributeKit, HPS::TextAttributeKit, HPS::CuttingSectionAttributeKit, HPS::CylinderAttributeKit, HPS::LightingAttributeKit, HPS::SphereAttributeKit, HPS::MarkerAttributeKit, HPS::CullingKit, HPS::ColorInterpolationKit, HPS::TransparencyKit, HPS::SelectabilityKit, HPS::CameraKit, HPS::VisibilityKit, HPS::BoundingKit, HPS::SegmentOptimizationOptionsKit, HPS::Publish::ExportOptionsKit, HPS::Publish::TextFieldKit, HPS::Publish::SignatureFieldKit, HPS::Publish::DropDownListKit, HPS::Exchange::TessellationOptionsKit, HPS::Publish::ListBoxKit, HPS::Exchange::ExportSTEPOptionsKit, HPS::Exchange::ExportParasolidOptionsKit, HPS::Publish::RadioButtonKit, HPS::Exchange::ExportIGESOptionsKit, HPS::Exchange::ExportXMLOptionsKit, HPS::Publish::CheckBoxKit, HPS::Exchange::ExportU3DOptionsKit, HPS::Exchange::ExportSTLOptionsKit, HPS::Publish::ButtonKit, HPS::Exchange::ExportPRCOptionsKit, HPS::Publish::LinkKit, HPS::Exchange::ExportJTOptionsKit, HPS::Publish::SlideTableKit, HPS::Exchange::ExportACISOptionsKit, HPS::Publish::TableKit, HPS::Exchange::Export3MFOptionsKit, HPS::Publish::ImageKit, HPS::Publish::TextKit, HPS::Exchange::ModelFileImportOptionsKit, HPS::Publish::ViewKit, HPS::Exchange::TranslationOptionsKit, HPS::Publish::ArtworkKit, HPS::Publish::AnnotationKit, HPS::ComponentPath, HPS::Exchange::ImportOptionsKit, HPS::Parasolid::ExportOptionsKit, HPS::Exchange::NURBSConversionOptionsKit, HPS::Parasolid::LineTessellationKit, HPS::Exchange::Configuration, HPS::Publish::PageKit, HPS::Parasolid::FacetTessellationKit, HPS::Publish::DocumentKit, HPS::Parasolid::ImportOptionsKit, HPS::DWG::ImportOptionsKit, HPS::OOC::ImportOptionsKit, HPS::Sketchup::ImportOptionsKit, and HPS::Sketchup::ImportResultsKit.

Equals()

bool HPS::Key::Equals ( Key const &  in_that ) const

inherited

Determines whether the database objects pointed to by this key and in_that are the same.

Empty keys (when key.Empty() returns true) are never equal to any key, even when the key is compared against itself (they act analogously to NaN comparisons in this case.)

GetClassID()

intptr_t HPS::Object::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns

A unique value shared by all objects of the same class.

GetFaceCount()

size_t HPS::ShellKey::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.

GetHash()

size_t HPS::Key::GetHash ( ) const

inherited

Returns a hash code for the key.

Returns

The size_t hash code.

Here is the caller graph for this function:

GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const

inherited

Returns an identifier that can be used to identify which instance of a class an object is.

Different keys and controls will return the same value if they are backed by the same database resource.

Returns

A value unique to an instance of an object and all objects that are backed by the same database resource.

GetPointCount()

size_t HPS::ShellKey::GetPointCount

(

)

const

Retrieves the number of points in this shell.

Returns

The number of points in this shell.

HasOwner()

bool HPS::Key::HasOwner ( ) const

inherited

Returns

Indicates whether this key has an owner or not.

HasType()

bool HPS::Object::HasType ( HPS::Type  in_mask ) const

inherited

This function indicates whether this Object has the given Type mask.

Parameters

in_mask

The Type mask to check against this Object.

Returns

true if this Object has the given Type mask, false otherwise.

MoveTo()

void HPS::Key::MoveTo ( SegmentKey const &  in_new_owner )

inherited

Moves the database object referred to by this key into a new containing segment pointed to by in_new_owner.

ObjectType()

HPS::Type HPS::ShellKey::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::GeometryKey.

operator!=()

bool HPS::Key::operator!= ( Key const &  in_that ) const

inherited

Determines whether the database objects pointed to by this key and in_that are the same.

operator=() [1/2]

ShellKey& HPS::ShellKey::operator=

(

ShellKey const &

other

)

Associate this ShellKey with the same underlying impl as the source ShellKey.

Parameters

in_that

The source ShellKey for the assignment.

Returns

A reference to this ShellKey.

operator=() [2/2]

ShellKey& HPS::ShellKey::operator=

(

ShellKey &&

in_that

)

The move assignment operator transfers the underlying impl of the rvalue reference to this ShellKey thereby avoiding a copy.

Parameters

in_that

An rvalue reference to a ShellKey to take the impl from.

Returns

A reference to this ShellKey.

operator==()

bool HPS::Key::operator== ( Key const &  in_that ) const

inherited

Determines whether the database objects pointed to by this key and in_that are the same.

Optimize()

void HPS::ShellKey::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.

Owner()

SegmentKey HPS::Key::Owner ( ) const

inherited

Returns

The segment containing this key.

Reset()

virtual void HPS::Object::Reset ( )

virtualinherited

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

Set()

void HPS::ShellKey::Set

(

ShellKit const &

in_kit

)

Replace those settings on this ShellKey with those set on the specified kit.

Parameters

in_kit

The kit from which to get the settings to replace on this ShellKey.

SetEdgeIndexColorsByList() [1/4]

ShellKey& HPS::ShellKey::SetEdgeIndexColorsByList	(	SizeTArray const &	in_vertices1,
		SizeTArray const &	in_vertices2,
		FloatArray const &	in_indices
	)

Sets edge material indices on a selection of arbitrary edges.

Parameters

in_vertices1	The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2	The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_indices	The material indices to set on the edges.

Returns

A reference to this ShellKey.

SetEdgeIndexColorsByList() [2/4]

ShellKey& HPS::ShellKey::SetEdgeIndexColorsByList	(	SizeTArray const &	in_vertices1,
		SizeTArray const &	in_vertices2,
		float	in_index
	)

Sets edge material indices on a selection of arbitrary edges.

Parameters

in_vertices1	The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2	The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_index	The material index to set on the edges.

Returns

A reference to this ShellKey.

SetEdgeIndexColorsByList() [3/4]

ShellKey& HPS::ShellKey::SetEdgeIndexColorsByList	(	size_t	in_count,
		size_t const	in_vertices1[],
		size_t const	in_vertices2[],
		float const	in_indices[]
	)

Sets edge material indices on a selection of arbitrary edges.

Parameters

in_count	Size of the following arrays.
in_vertices1	The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2	The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_indices	The material indices to set on the edges.

Returns

A reference to this ShellKey.

SetEdgeIndexColorsByList() [4/4]

ShellKey& HPS::ShellKey::SetEdgeIndexColorsByList	(	size_t	in_count,
		size_t const	in_vertices1[],
		size_t const	in_vertices2[],
		float	in_index
	)

Sets edge material indices on a selection of arbitrary edges.

Parameters

in_count	Size of the following arrays.
in_vertices1	The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2	The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_index	The material index to set on the edges.

Returns

A reference to this ShellKey.

SetEdgeRGBColorsByList() [1/4]

ShellKey& HPS::ShellKey::SetEdgeRGBColorsByList	(	SizeTArray const &	in_vertices1,
		SizeTArray const &	in_vertices2,
		RGBColorArray const &	in_rgb_colors
	)

Sets edge colors on a selection of arbitrary edges.

Parameters

in_vertices1	The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2	The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_rgb_colors	The colors to set on the edges.

Returns

A reference to this ShellKey.

SetEdgeRGBColorsByList() [2/4]

ShellKey& HPS::ShellKey::SetEdgeRGBColorsByList	(	SizeTArray const &	in_vertices1,
		SizeTArray const &	in_vertices2,
		RGBColor const &	in_rgb_color
	)

Sets edge colors on a selection of arbitrary edges.

Parameters

in_vertices1	The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2	The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_rgb_color	The color to set on the edges.

Returns

A reference to this ShellKey.

SetEdgeRGBColorsByList() [3/4]

ShellKey& HPS::ShellKey::SetEdgeRGBColorsByList	(	size_t	in_count,
		size_t const	in_vertices1[],
		size_t const	in_vertices2[],
		RGBColor const	in_rgb_colors[]
	)

Sets edge colors on a selection of arbitrary edges.

Parameters

in_count	Size of the following arrays.
in_vertices1	The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2	The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_rgb_colors	The colors to set on the edges.

Returns

A reference to this ShellKey.

SetEdgeRGBColorsByList() [4/4]

ShellKey& HPS::ShellKey::SetEdgeRGBColorsByList	(	size_t	in_count,
		size_t const	in_vertices1[],
		size_t const	in_vertices2[],
		RGBColor const	in_rgb_color
	)

Sets edge colors on a selection of arbitrary edges.

Parameters

in_count	Size of the following arrays.
in_vertices1	The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2	The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_rgb_color	The color to set on the edges.

Returns

A reference to this ShellKey.

SetEdgeVisibilitiesByList() [1/4]

ShellKey& HPS::ShellKey::SetEdgeVisibilitiesByList	(	size_t	in_count,
		size_t const	in_vertices1[],
		size_t const	in_vertices2[],
		bool const	in_visibilities[]
	)

Sets edge visibilities on a selection of arbitrary edges.

Parameters

in_count	Size of the following arrays.
in_vertices1	The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2	The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_visibilities	The visibilities that should be set for each edge specified.

Returns

A reference to this ShellKey.

SetEdgeVisibilitiesByList() [2/4]

ShellKey& HPS::ShellKey::SetEdgeVisibilitiesByList	(	size_t	in_count,
		size_t const	in_vertices1[],
		size_t const	in_vertices2[],
		bool	in_visibility
	)

Sets edge visibilities on a selection of arbitrary edges.

Parameters

in_count	Size of the following arrays.
in_vertices1	The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2	The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_visibility	The visibility to apply to each edge specified.

Returns

A reference to this ShellKey.

SetEdgeVisibilitiesByList() [3/4]

ShellKey& HPS::ShellKey::SetEdgeVisibilitiesByList	(	SizeTArray const &	in_vertices1,
		SizeTArray const &	in_vertices2,
		bool	in_visibility
	)

Sets edge visibilities on a selection of arbitrary edges.

Parameters

in_vertices1	The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2	The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_visibility	The visibility to apply to each edge specified.

Returns

A reference to this ShellKey.

SetEdgeVisibilitiesByList() [4/4]

ShellKey& HPS::ShellKey::SetEdgeVisibilitiesByList	(	SizeTArray const &	in_vertices1,
		SizeTArray const &	in_vertices2,
		BoolArray const &	in_visibilities
	)

Sets edge visibilities on a selection of arbitrary edges.

Parameters

in_vertices1	The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2	The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_visibilities	The visibilities that should be set for each edge specified.

Returns

A reference to this ShellKey.

SetFaceIndexColorsByList() [1/4]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_faces[i]<face_count for setting to succeed.
in_indices	The material indices to set on the faces.

Returns

A reference to this ShellKey.

SetFaceIndexColorsByList() [2/4]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_faces[i]<face_count for setting to succeed.
in_indices	The material indices to set on the faces.

Returns

A reference to this ShellKey.

SetFaceIndexColorsByList() [3/4]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_faces[i]<face_count for setting to succeed.
in_index	The material index to set on the faces.

Returns

A reference to this ShellKey.

SetFaceIndexColorsByList() [4/4]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_faces[i]<face_count for setting to succeed.
in_index	The material index to set on the faces.

Returns

A reference to this ShellKey.

SetFaceIndexColorsByRange() [1/3]

ShellKey& HPS::ShellKey::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 ShellKey at which to start setting colors. This value must be such that in_start<face_count for setting to succeed.
in_count	Size of the following array. This value must be such that in_start+in_count<=face_count for the setting to succeed.
in_indices	The material indices to set on the faces for this ShellKey.

Returns

A reference to this ShellKey.

SetFaceIndexColorsByRange() [2/3]

ShellKey& HPS::ShellKey::SetFaceIndexColorsByRange	(	size_t	in_start,
		FloatArray 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 ShellKey at which to start setting colors. This value must be such that in_start<face_count for setting to succeed.
in_indices	The material indices to set on the faces for this ShellKey. The size of the array must be such that in_start+in_indices.size()<=face_count for the setting to succeed.

Returns

A reference to this ShellKey.

SetFaceIndexColorsByRange() [3/3]

ShellKey& HPS::ShellKey::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 ShellKey at which to start setting the color. This value must be such that in_start<face_count for setting to succeed.
in_count	The number of faces on which to set the color. This value must be such that in_start+in_count<=face_count for the setting to succeed.
in_index	The material index to set on the faces for this ShellKey.

Returns

A reference to this ShellKey.

SetFacelist() [1/2]

ShellKey& HPS::ShellKey::SetFacelist

(

IntArray const &

in_facelist

)

Replace the face list on this ShellKey with the specified face list.

Parameters

in_facelist

The face list to use to replace the one for this ShellKey.

Returns

A reference to this ShellKey.

SetFacelist() [2/2]

ShellKey& HPS::ShellKey::SetFacelist	(	size_t	in_count,
		int const	in_facelist[]
	)

Replace the face list on this ShellKey with the specified face list.

Parameters

in_count	Size of the following array.
in_facelist	The face list to use to replace the one for this ShellKey.

Returns

A reference to this ShellKey.

SetFaceNormalsByList() [1/4]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_faces[i]<face_count for setting to succeed.
in_normals	The normals to set on the faces.

Returns

A reference to this ShellKey.

SetFaceNormalsByList() [2/4]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_faces[i]<face_count for setting to succeed.
in_normals	The normals to set on the faces.

Returns

A reference to this ShellKey.

SetFaceNormalsByList() [3/4]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_faces[i]<face_count for setting to succeed.
in_normal	The normal to set on the faces.

Returns

A reference to this ShellKey.

SetFaceNormalsByList() [4/4]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_faces[i]<face_count for setting to succeed.
in_normal	The normal to set on the faces.

Returns

A reference to this ShellKey.

SetFaceNormalsByRange() [1/3]

ShellKey& HPS::ShellKey::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 ShellKey at which to start setting normals. This value must be such that in_start<face_count for setting to succeed.
in_count	Size of the following array. This value must be such that in_start+in_count<=face_count for the setting to succeed.
in_normals	The normals to set on the faces for this ShellKey.

Returns

A reference to this ShellKey.

SetFaceNormalsByRange() [2/3]

ShellKey& HPS::ShellKey::SetFaceNormalsByRange	(	size_t	in_start,
		VectorArray 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 ShellKey at which to start setting normals. This value must be such that in_start<face_count for setting to succeed.
in_normals	The normals to set on the faces for this ShellKey. The size of the array must be such that in_start+in_normals.size()<=face_count for the setting to succeed.

Returns

A reference to this ShellKey.

SetFaceNormalsByRange() [3/3]

ShellKey& HPS::ShellKey::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 ShellKey at which to start setting the normal. This value must be such that in_start<face_count for setting to succeed.
in_count	The number of faces on which to set the normal. This value must be such that in_start+in_count<=face_count for the setting to succeed.
in_normal	The normal to set on the faces for this ShellKey.

Returns

A reference to this ShellKey.

SetFaceRGBColorsByList() [1/4]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_faces[i]<face_count for setting to succeed.
in_rgb_colors	The RGB colors to set on the faces.

Returns

A reference to this ShellKey.

SetFaceRGBColorsByList() [2/4]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_faces[i]<face_count for setting to succeed.
in_rgb_colors	The RGB colors to set on the faces.

Returns

A reference to this ShellKey.

SetFaceRGBColorsByList() [3/4]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_faces[i]<face_count for setting to succeed.
in_rgb_color	The RGB color to set on the faces.

Returns

A reference to this ShellKey.

SetFaceRGBColorsByList() [4/4]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_faces[i]<face_count for setting to succeed.
in_rgb_color	The RGB color to set on the faces.

Returns

A reference to this ShellKey.

SetFaceRGBColorsByRange() [1/3]

ShellKey& HPS::ShellKey::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 ShellKey at which to start setting colors. This value must be such that in_start<face_count for setting to succeed.
in_count	Size of the following array. This value must be such that in_start+in_count<=face_count for the setting to succeed.
in_rgb_colors	The RGB colors to set on the faces for this ShellKey.

Returns

A reference to this ShellKey.

SetFaceRGBColorsByRange() [2/3]

ShellKey& HPS::ShellKey::SetFaceRGBColorsByRange	(	size_t	in_start,
		RGBColorArray 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 ShellKey at which to start setting colors. This value must be such that in_start<face_count for setting to succeed.
in_rgb_colors	The RGB colors to set on the faces for this ShellKey. The size of the array must be such that in_start+in_rgb_colors.size()<=face_count for the setting to succeed.

Returns

A reference to this ShellKey.

SetFaceRGBColorsByRange() [3/3]

ShellKey& HPS::ShellKey::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 ShellKey at which to start setting the color. This value must be such that in_start<face_count for setting to succeed.
in_count	The number of faces on which to set the color. This value must be such that in_start+in_count<=face_count for the setting to succeed.
in_rgb_color	The RGB color to set on the faces for this ShellKey.

Returns

A reference to this ShellKey.

SetFaceVisibilitiesByList() [1/4]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_faces[i]<face_count for setting to succeed.
in_visibilities	The visibilities to set on the faces.

Returns

A reference to this ShellKey.

SetFaceVisibilitiesByList() [2/4]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_faces[i]<face_count for setting to succeed.
in_visibilities	The visibilities to set on the faces.

Returns

A reference to this ShellKey.

SetFaceVisibilitiesByList() [3/4]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_faces[i]<face_count for setting to succeed.
in_visibility	The visibility to set on the faces.

Returns

A reference to this ShellKey.

SetFaceVisibilitiesByList() [4/4]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_faces[i]<face_count for setting to succeed.
in_visibility	The visibility to set on the faces.

Returns

A reference to this ShellKey.

SetFaceVisibilitiesByRange() [1/3]

ShellKey& HPS::ShellKey::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 ShellKey at which to start setting visibilities. This value must be such that in_start<face_count for setting to succeed.
in_count	Size of the following array. This value must be such that in_start+in_count<=face_count for the setting to succeed.
in_visibilities	The visibilities to set on the faces for this ShellKey.

Returns

A reference to this ShellKey.

SetFaceVisibilitiesByRange() [2/3]

ShellKey& HPS::ShellKey::SetFaceVisibilitiesByRange	(	size_t	in_start,
		BoolArray 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 ShellKey at which to start setting visibilities. This value must be such that in_start<face_count for setting to succeed.
in_visibilities	The visibilities to set on the faces for this ShellKey. The size of the array must be such that in_start+in_visibilities.size()<=face_count for the setting to succeed.

Returns

A reference to this ShellKey.

SetFaceVisibilitiesByRange() [3/3]

ShellKey& HPS::ShellKey::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 ShellKey at which to start setting the visibility. This value must be such that in_start<face_count for setting to succeed.
in_count	The number of faces on which to set the visibility. This value must be such that in_start+in_count<=face_count for the setting to succeed.
in_visibility	The visibility to set on the faces for this ShellKey.

Returns

A reference to this ShellKey.

SetMaterialMapping()

ShellKey& HPS::ShellKey::SetMaterialMapping

(

MaterialMappingKit const &

in_kit

)

Sets the specified material mappings on this ShellKey.

Only face, back face, cut edge, cut face, edge, and vertex materials will be set on the 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 ShellKey.

Returns

A reference to this ShellKey.

SetPoints() [1/2]

ShellKey& HPS::ShellKey::SetPoints

(

PointArray const &

in_points

)

Replace the points on this ShellKey with the specified points.

Parameters

in_points

The points to use to replace those for this ShellKey.

Returns

A reference to this ShellKey.

SetPoints() [2/2]

ShellKey& HPS::ShellKey::SetPoints	(	size_t	in_count,
		Point const	in_points[]
	)

Replace the points on this ShellKey with the specified points.

Parameters

in_count	Size of the following array.
in_points	The points to use to replace those for this ShellKey.

Returns

A reference to this ShellKey.

SetPriority()

GeometryKey& HPS::GeometryKey::SetPriority ( int  in_priority )

inherited

Assigns a drawing priority value to the geometry.

It affects the order in which the geometry is visited if and only if the rendering algorithm is set to Priority. The geometry has a default drawing priority assigned, based on the order of insertion.

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::SetRenderingAlgorithm()

SetTristrips() [1/2]

ShellKey& HPS::ShellKey::SetTristrips

(

IntArray const &

in_tristrips

)

Replace the face list on this ShellKey with the specified face list.

Parameters

in_tristrips

The tristrips list to use to replace the one for this ShellKey.

Returns

A reference to this ShellKey.

SetTristrips() [2/2]

ShellKey& HPS::ShellKey::SetTristrips	(	size_t	in_count,
		int const	in_tristrips[]
	)

Replace the face list on this ShellKey with the specified face list.

Parameters

in_count	Size of the following array.
in_tristrips	The tristrips list to use to replace the one for this ShellKey.

Returns

A reference to this ShellKey.

SetUserData() [1/3]

GeometryKey& HPS::GeometryKey::SetUserData ( intptr_t  in_index, size_t  in_bytes, byte const  in_data[]  )

inherited

Sets user data on this key.

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 key.

SetUserData() [2/3]

GeometryKey& HPS::GeometryKey::SetUserData ( intptr_t  in_index, ByteArray const &  in_data  )

inherited

Sets user data on this key.

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 key.

SetUserData() [3/3]

GeometryKey& HPS::GeometryKey::SetUserData ( IntPtrTArray const &  in_indices, ByteArrayArray const &  in_data  )

inherited

Sets user data on this key.

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 key.

SetVertexIndexColorsByList() [1/4]

ShellKey& HPS::ShellKey::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 ShellKey.

SetVertexIndexColorsByList() [2/4]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
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 ShellKey.

SetVertexIndexColorsByList() [3/4]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
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 ShellKey.

SetVertexIndexColorsByList() [4/4]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
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 ShellKey.

SetVertexIndexColorsByRange() [1/3]

ShellKey& HPS::ShellKey::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 ShellKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed.
in_count	Size of the following array. This value must be such that in_start+in_count<=point_count for the setting to succeed.
in_indices	The material indices to set on the vertices for this ShellKey.
in_apply_to	The shell component the colors should apply to. Defaults to Shell::Component::Faces.

Returns

A reference to this ShellKey.

SetVertexIndexColorsByRange() [2/3]

ShellKey& HPS::ShellKey::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 ShellKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed.
in_indices	The material indices to set on the vertices for this ShellKey. The size of the array must be such that in_start+in_indices.size()<=point_count for the setting to succeed.
in_apply_to	The shell component the colors should apply to. Defaults to Shell::Component::Faces.

Returns

A reference to this ShellKey.

SetVertexIndexColorsByRange() [3/3]

ShellKey& HPS::ShellKey::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 ShellKey at which to start setting the color. This value must be such that in_start<point_count for setting to succeed.
in_count	The number of vertices on which to set the color. This value must be such that in_start+in_count<=point_count for the setting to succeed.
in_index	The material index to set on the vertices for this ShellKey.
in_apply_to	The shell component the colors should apply to. Defaults to Shell::Component::Faces.

Returns

A reference to this ShellKey.

SetVertexNormalsByList() [1/4]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_normals	The normals to set on the vertices.

Returns

A reference to this ShellKey.

SetVertexNormalsByList() [2/4]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_normals	The normals to set on the vertices.

Returns

A reference to this ShellKey.

SetVertexNormalsByList() [3/4]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_normal	The normal to set on the vertices.

Returns

A reference to this ShellKey.

SetVertexNormalsByList() [4/4]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_normal	The normal to set on the vertices.

Returns

A reference to this ShellKey.

SetVertexNormalsByRange() [1/3]

ShellKey& HPS::ShellKey::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 ShellKey at which to start setting normals. This value must be such that in_start<point_count for setting to succeed.
in_count	Size of the following array. This value must be such that in_start+in_count<=point_count for the setting to succeed.
in_normals	The normals to set on the vertices for this ShellKey.

Returns

A reference to this ShellKey.

SetVertexNormalsByRange() [2/3]

ShellKey& HPS::ShellKey::SetVertexNormalsByRange	(	size_t	in_start,
		VectorArray 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 ShellKey at which to start setting normals. This value must be such that in_start<point_count for setting to succeed.
in_normals	The normals to set on the vertices for this ShellKey. The size of the array must be such that in_start+in_normals.size()<=point_count for the setting to succeed.

Returns

A reference to this ShellKey.

SetVertexNormalsByRange() [3/3]

ShellKey& HPS::ShellKey::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 ShellKey at which to start setting the normal. This value must be such that in_start<point_count for setting to succeed.
in_count	The number of vertices on which to set the normal. This value must be such that in_start+in_count<=point_count for the setting to succeed.
in_normal	The normal to set on the vertices for this ShellKey.

Returns

A reference to this ShellKey.

SetVertexParametersByList() [1/2]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
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 ShellKey.
in_param_width	The number of texture parameters per vertex. Defaults to 2.

Returns

A reference to this ShellKey.

SetVertexParametersByList() [2/2]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_params	The texture parameters to set on the vertices for this ShellKey. 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 ShellKey.

SetVertexParametersByRange() [1/2]

ShellKey& HPS::ShellKey::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 ShellKey at which to start setting texture parameters. This value must be such that in_start<point_count for setting to succeed.
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. This value must be such that in_start+in_param_count/in_param_width<=point_count for the setting to succeed.
in_params	The texture parameters to set on the vertices for this ShellKey.
in_param_width	The number of texture parameters per vertex. Defaults to 2.

Returns

A reference to this ShellKey.

SetVertexParametersByRange() [2/2]

ShellKey& HPS::ShellKey::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 ShellKey at which to start setting texture parameters. This value must be such that in_start<point_count for setting to succeed.
in_params	The texture parameters to set on the vertices for this ShellKey. The size of the array should be divisible by the parameter width, if it is not, some parameters will get ignored. The size of the array must be such that in_start+in_params.size()/in_param_width<=point_count for the setting to succeed.
in_param_width	The number of texture parameters per vertex. Defaults to 2.

Returns

A reference to this ShellKey.

SetVertexRGBAColorsByList() [1/4]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
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 ShellKey.

SetVertexRGBAColorsByList() [2/4]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
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 ShellKey.

SetVertexRGBAColorsByList() [3/4]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
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 ShellKey.

SetVertexRGBAColorsByList() [4/4]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
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 ShellKey.

SetVertexRGBAColorsByRange() [1/3]

ShellKey& HPS::ShellKey::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 ShellKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed.
in_count	Size of the following array. This value must be such that in_start+in_count<=point_count for the setting to succeed.
in_rgba_colors	The RGBA colors to set on the vertices for this ShellKey.
in_apply_to	The shell component the colors should apply to. Defaults to Shell::Component::Faces.

Returns

A reference to this ShellKey.

SetVertexRGBAColorsByRange() [2/3]

ShellKey& HPS::ShellKey::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 ShellKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed.
in_rgba_colors	The RGBA colors to set on the vertices for this ShellKey. The size of the array must be such that in_start+in_rgba_colors.size()<=point_count for the setting to succeed.
in_apply_to	The shell component the colors should apply to. Defaults to Shell::Component::Faces.

Returns

A reference to this ShellKey.

SetVertexRGBAColorsByRange() [3/3]

ShellKey& HPS::ShellKey::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 ShellKey at which to start setting the color. This value must be such that in_start<point_count for setting to succeed.
in_count	The number of vertices on which to set the color. This value must be such that in_start+in_count<=point_count for the setting to succeed.
in_rgba_color	The RGBA color to set on the vertices for this ShellKey.
in_apply_to	The shell component the colors should apply to. Defaults to Shell::Component::Faces.

Returns

A reference to this ShellKey.

SetVertexRGBColorsByList() [1/4]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
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 ShellKey.

SetVertexRGBColorsByList() [2/4]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
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 ShellKey.

SetVertexRGBColorsByList() [3/4]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
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 ShellKey.

SetVertexRGBColorsByList() [4/4]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
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 ShellKey.

SetVertexRGBColorsByRange() [1/3]

ShellKey& HPS::ShellKey::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 ShellKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed.
in_count	Size of the following array. This value must be such that in_start+in_count<=point_count for the setting to succeed.
in_rgb_colors	The RGB colors to set on the vertices for this ShellKey.
in_apply_to	The shell component the colors should apply to. Defaults to Shell::Component::Faces.

Returns

A reference to this ShellKey.

SetVertexRGBColorsByRange() [2/3]

ShellKey& HPS::ShellKey::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 ShellKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed.
in_rgb_colors	The RGB colors to set on the vertices for this ShellKey. The size of the array must be such that in_start+in_rgb_colors.size()<=point_count for the setting to succeed.
in_apply_to	The shell component the colors should apply to. Defaults to Shell::Component::Faces.

Returns

A reference to this ShellKey.

SetVertexRGBColorsByRange() [3/3]

ShellKey& HPS::ShellKey::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 ShellKey at which to start setting the color. This value must be such that in_start<point_count for setting to succeed.
in_count	The number of vertices on which to set the color. This value must be such that in_start+in_count<=point_count for the setting to succeed.
in_rgb_color	The RGB color to set on the vertices for this ShellKey.
in_apply_to	The shell component the colors should apply to. Defaults to Shell::Component::Faces.

Returns

A reference to this ShellKey.

SetVertexVisibilitiesByList() [1/4]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_visibilities	The visibilities to set on the vertices.

Returns

A reference to this ShellKey.

SetVertexVisibilitiesByList() [2/4]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_visibilities	The visibilities to set on the vertices.

Returns

A reference to this ShellKey.

SetVertexVisibilitiesByList() [3/4]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_visibility	The visibility to set on the vertices.

Returns

A reference to this ShellKey.

SetVertexVisibilitiesByList() [4/4]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_visibility	The visibility to set on the vertices.

Returns

A reference to this ShellKey.

SetVertexVisibilitiesByRange() [1/3]

ShellKey& HPS::ShellKey::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 ShellKey at which to start setting visibilities. This value must be such that in_start<point_count for setting to succeed.
in_count	Size of the following array. This value must be such that in_start+in_count<=point_count for the setting to succeed.
in_visibilities	The visibilities to set on the vertices for this ShellKey.

Returns

A reference to this ShellKey.

SetVertexVisibilitiesByRange() [2/3]

ShellKey& HPS::ShellKey::SetVertexVisibilitiesByRange	(	size_t	in_start,
		BoolArray 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 ShellKey at which to start setting visibilities. This value must be such that in_start<point_count for setting to succeed.
in_visibilities	The visibilities to set on the vertices for this ShellKey. The size of the array must be such that in_start+in_visibilities.size()<=point_count for the setting to succeed.

Returns

A reference to this ShellKey.

SetVertexVisibilitiesByRange() [3/3]

ShellKey& HPS::ShellKey::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 ShellKey at which to start setting the visibility. This value must be such that in_start<point_count for setting to succeed.
in_count	The number of vertices on which to set the visibility. This value must be such that in_start+in_count<=point_count for the setting to succeed.
in_visibility	The visibility to set on the vertices for this ShellKey.

Returns

A reference to this ShellKey.

Show()

void HPS::ShellKey::Show

(

ShellKit &

out_kit

)

const

Copy the contents of this ShellKey into the specified kit.

Parameters

out_kit

The kit to populate with the contents of this ShellKey.

ShowBounding()

bool HPS::GeometryKey::ShowBounding ( BoundingKit &  out_kit ) const

inherited

Shows the bounding of this geometry.

Parameters

out_kit

The BoundingKit that is set on this GeometryKey

Returns

False if no bounding exists.

ShowEdgeColors()

bool HPS::ShellKey::ShowEdgeColors	(	SizeTArray &	out_vertices1,
		SizeTArray &	out_vertices2,
		HPS::MaterialTypeArray &	out_types,
		HPS::RGBColorArray &	out_rgb_colors,
		HPS::FloatArray &	out_indices
	)

Sets edge colors on a selection of arbitrary edges.

Parameters

out_vertices1	The vertex indices that correspond to the start position of each edge for which the visibilities are being changed.
out_vertices2	The vertex indices that correspond to the end position of each edge for which the visibilities are being changed.
out_types	The types of edge colors for each edge.
out_rgb_colors	The colors that have been set on each edge. A given element of this array is valid only if the equivalent element of out_types is RGBColor.
out_indices	The colors that have been set on each edge. A given element of this array is valid only if the equivalent element of out_types is MaterialIndex.

Returns

A reference to this ShellKey.

ShowEdgeColorsByList()

bool HPS::ShellKey::ShowEdgeColorsByList	(	SizeTArray const &	in_vertices1,
		SizeTArray const &	in_vertices2,
		HPS::MaterialTypeArray &	out_types,
		HPS::RGBColorArray &	out_rgb_colors,
		HPS::FloatArray &	out_indices
	)

Sets edge colors on a selection of arbitrary edges.

Parameters

in_vertices1	The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2	The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
out_types	The types of edge colors for each edge.
out_rgb_colors	The colors that have been set on each edge. A given element of this array is valid only if the equivalent element of out_types is Material::Type::RGBColor.
out_indices	The colors that have been set on each edge. A given element of this array is valid only if the equivalent element of out_types is Material::Type::MaterialIndex.

Returns

A reference to this ShellKey.

ShowEdgeVisibilitiesByList()

bool HPS::ShellKey::ShowEdgeVisibilitiesByList	(	SizeTArray const &	in_vertices1,
		SizeTArray const &	in_vertices2,
		BoolArray &	out_validities,
		BoolArray &	out_visibilities
	)		const

Shows all the edge visibilities on this ShellKey.

Parameters

in_vertices1	The vertex indices that correspond to the start position of each edge for which the visibilities are being shown. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2	The vertex indices that correspond to the end position of each edge for which the visibilities are being shown. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
out_validities	The validities of the visibilities for each edge. If an edge has a visibility set on it, the entry in this array will be true, otherwise it will be false.
out_visibilities	The edge visibilities for each edge. out_visibilities[i] is only valid if out_validities[i] is true.

Returns

true if any vertex had a vertex visibility set, false otherwise.

ShowFaceColors()

bool HPS::ShellKey::ShowFaceColors	(	MaterialTypeArray &	out_types,
		RGBColorArray &	out_rgb_colors,
		FloatArray &	out_indices
	)		const

Shows the face colors on ShellKey.

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.

ShowFaceColorsByList()

bool HPS::ShellKey::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. Each index in the array must be such that in_faces[i]<face_count for showing to succeed.
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.

ShowFaceColorsByRange()

bool HPS::ShellKey::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 ShellKey at which to start showing colors. This value must be such that in_start<face_count for showing to succeed.
in_count	The number of colors to show. This value must be such that in_start+in_count<=face_count for the showing to succeed.
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.

ShowFacelist()

bool HPS::ShellKey::ShowFacelist

(

IntArray &

out_facelist

)

const

Show the face list for this ShellKey.

Parameters

out_facelist

The face list for this ShellKey.

Returns

true if face list was set, false otherwise.

ShowFaceNormals()

bool HPS::ShellKey::ShowFaceNormals	(	BoolArray &	out_validities,
		VectorArray &	out_normals
	)		const

Shows all the face normals for this ShellKey.

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.

ShowFaceNormalsByList()

bool HPS::ShellKey::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. Each index in the array must be such that in_faces[i]<face_count for showing to succeed.
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.

ShowFaceNormalsByRange()

bool HPS::ShellKey::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 ShellKey at which to start showing normals. This value must be such that in_start<face_count for showing to succeed.
in_count	The number of normals to show. This value must be such that in_start+in_count<=face_count for the showing to succeed.
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.

ShowFaceVisibilities()

bool HPS::ShellKey::ShowFaceVisibilities	(	BoolArray &	out_validities,
		BoolArray &	out_visibilities
	)		const

Shows all the face visibilities on this ShellKey.

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.

ShowFaceVisibilitiesByList()

bool HPS::ShellKey::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. Each index in the array must be such that in_faces[i]<face_count for showing to succeed.
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.

ShowFaceVisibilitiesByRange()

bool HPS::ShellKey::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 ShellKey at which to start showing visibilities. This value must be such that in_start<face_count for showing to succeed.
in_count	The number of visibilities to show. This value must be such that in_start+in_count<=face_count for the showing to succeed.
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.

ShowMaterialMapping()

bool HPS::ShellKey::ShowMaterialMapping

(

MaterialMappingKit &

out_kit

)

const

Shows the material mappings set on this ShellKey.

These are the "global" material settings, not the per-vertex and per-face material settings.

Parameters

out_kit

The material mappings set on this ShellKey.

Returns

true if material mappings were set, false otherwise.

ShowNetFaceNormalsByList()

bool HPS::ShellKey::ShowNetFaceNormalsByList	(	SizeTArray const &	in_faces,
		VectorArray &	out_normals
	)		const

Shows the effective face normals on a selection of arbitrary faces.

If a normal for a given face is unspecified, this will retrieve the effective normal. 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. Each index in the array must be such that in_faces[i]<face_count for showing to succeed.
out_normals	The face normals for each face at the specified index.

Returns

true if no errors were encountered, false otherwise.

ShowNetFaceNormalsByRange()

bool HPS::ShellKey::ShowNetFaceNormalsByRange	(	size_t	in_start,
		size_t	in_count,
		VectorArray &	out_normals
	)		const

Shows the effective face normals on a range of faces starting at the specified offset.

If a normal for a given face is unspecified, this will retrieve the effective normal.

Parameters

in_start	The offset into the faces for this ShellKey at which to start showing normals. This value must be such that in_start<face_count for showing to succeed.
in_count	The number of normals to show. This value must be such that in_start+in_count<=face_count for the showing to succeed.
out_normals	The face normals for each face in the specified range.

Returns

true if no errors were encountered, false otherwise.

ShowNetVertexNormals()

bool HPS::ShellKey::ShowNetVertexNormals

(

VectorArray &

out_normals

)

const

Shows the all net vertex normals on this ShellKey.

Parameters

out_normals

The vertex normals for each vertex.

Returns

true if no errors were encountered, false otherwise.

ShowNetVertexNormalsByRange()

bool HPS::ShellKey::ShowNetVertexNormalsByRange	(	size_t	in_start,
		size_t	in_count,
		VectorArray &	out_normals
	)		const

Shows the net vertex normals on a range of vertices starting at the specified offset.

Parameters

in_start	The offset into the vertices for this ShellKey at which to start showing normals. This value must be such that in_start<point_count for showing to succeed.
in_count	The number of normals to show. This value must be such that in_start+in_count<=point_count for the showing to succeed.
out_normals	The vertex normals for each vertex in the specified range.

Returns

true if no errors were encountered, false otherwise.

ShowPoints()

bool HPS::ShellKey::ShowPoints

(

PointArray &

out_points

)

const

Show the points for this ShellKey.

Parameters

out_points

The points for this ShellKey.

Returns

true if points were set, false otherwise.

ShowPointsByList() [1/2]

bool HPS::ShellKey::ShowPointsByList	(	SizeTArray const &	in_indices,
		PointArray &	out_points
	)		const

Show a subset of the points for this ShellKey by list.

Parameters

in_indices	The list of point indices to show.
out_points	The requested points for this ShellKey.

Returns

true if all requested points were set, false otherwise.

ShowPointsByList() [2/2]

bool HPS::ShellKey::ShowPointsByList	(	size_t	in_count,
		size_t const	in_indices[],
		PointArray &	out_points
	)		const

Show a subset of the points for this ShellKey by list.

Parameters

in_count	The number of points to show.
in_indices	The list of point indices to show.
out_points	The requested points for this ShellKey.

Returns

true if all requested points were set, false otherwise.

ShowPointsByRange()

bool HPS::ShellKey::ShowPointsByRange	(	size_t	in_start_index,
		size_t	in_count,
		PointArray &	out_points
	)		const

Show a subset of the points for this ShellKey by range.

Parameters

in_start_index	The first point to show.
in_count	The number of points to show.
out_points	The requested points for this ShellKey.

Returns

true if all requested points were set, false otherwise.

ShowPriority()

bool HPS::GeometryKey::ShowPriority ( int &  out_priority ) const

inherited

Shows the drawing priority.

Parameters

out_priority

The drawing priority; higher priority items are drawn on top of lower priority items.

Returns

true if a priority was specified, false otherwise.

ShowReferrers() [1/2]

size_t HPS::GeometryKey::ShowReferrers ( SegmentKeyArray &  out_segments ) const

inherited

Shows the all the segments which contain references to this key.

Note that while a segment may only appear once in the returned array, that segment could have multiple references to this key.

Parameters

out_segments

The list of segments which contains references to this key.

Returns

The number of segments which contain references to this key.

ShowReferrers() [2/2]

size_t HPS::GeometryKey::ShowReferrers ( ReferenceKeyArray &  out_references ) const

inherited

Shows the all the references to this key.

Parameters

out_references

The list of all references to this key.

Returns

The number of references to this key.

ShowTristrips() [1/2]

bool HPS::ShellKey::ShowTristrips

(

IntArray &

out_tristrips

)

const

Show the tristrips list for this ShellKey.

Parameters

out_tristrips

The tristrip list for this ShellKey.

Returns

true if tristrips list was set, false otherwise.

ShowTristrips() [2/2]

bool HPS::ShellKey::ShowTristrips	(	IntArray &	out_tristrips,
		IntArray &	out_face_indices
	)		const

Show the tristrips list for this ShellKey.

Parameters

out_tristrips	The tristrip list for this ShellKey.
out_face_indices	The corresponding face indices for each triangle in the tristrip list.

Returns

true if tristrips list was set, false otherwise.

ShowUserData() [1/2]

bool HPS::GeometryKey::ShowUserData ( intptr_t  in_index, ByteArray &  out_data  ) const

inherited

Shows the user data at a given index for this key.

Parameters

in_index	The index of the user data to show.
out_data	The user data at the given index.

Returns

true if there is user data at the given index, false otherwise.

ShowUserData() [2/2]

bool HPS::GeometryKey::ShowUserData ( IntPtrTArray &  out_indices, ByteArrayArray &  out_data  ) const

inherited

Shows all user data for this key.

Parameters

out_indices	An array of all user data indices set on this key.
out_data	An array of all user data set on this key.

Returns

true if there is user data on this key, false otherwise.

ShowUserDataCount()

size_t HPS::GeometryKey::ShowUserDataCount ( ) const

inherited

Get the number of user data indices set on this key.

ShowUserDataIndices()

bool HPS::GeometryKey::ShowUserDataIndices ( IntPtrTArray &  out_indices ) const

inherited

Shows the indices of all user data set on this key.

Parameters

out_indices

The user data indices set on this key.

Returns

The number of user data indices set on this key.

ShowVertexColors()

bool HPS::ShellKey::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.

ShowVertexColorsByList()

bool HPS::ShellKey::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. Each index in the array must be such that in_vertices[i]<point_count for showing to succeed.
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.

ShowVertexColorsByRange()

bool HPS::ShellKey::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 ShellKey at which to start showing colors. This value must be such that in_start<point_count for showing to succeed.
in_count	The number of colors to show. This value must be such that in_start+in_count<=point_count for the showing to succeed.
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.

ShowVertexNormals()

bool HPS::ShellKey::ShowVertexNormals	(	BoolArray &	out_validities,
		VectorArray &	out_normals
	)		const

Shows all the vertex normals on this ShellKey.

Parameters

out_validities	The validities of the normals for each vertex. 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.

ShowVertexNormalsByList()

bool HPS::ShellKey::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. Each index in the array must be such that in_vertices[i]<point_count for showing to succeed.
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.

ShowVertexNormalsByRange()

bool HPS::ShellKey::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 ShellKey at which to start showing normals. This value must be such that in_start<point_count for showing to succeed.
in_count	The number of normals to show. This value must be such that in_start+in_count<=point_count for the showing to succeed.
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.

ShowVertexParameters() [1/2]

bool HPS::ShellKey::ShowVertexParameters	(	BoolArray &	out_validities,
		FloatArray &	out_params
	)		const

Shows the texture parameters for all of the vertices on this ShellKey.

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.

ShowVertexParameters() [2/2]

bool HPS::ShellKey::ShowVertexParameters	(	BoolArray &	out_validities,
		FloatArray &	out_params,
		size_t &	out_param_width
	)		const

Shows the texture parameters for all of the vertices on this ShellKey.

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.

ShowVertexParametersByList() [1/2]

bool HPS::ShellKey::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. Each index in the array must be such that in_vertices[i]<point_count for showing to succeed.
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.

ShowVertexParametersByList() [2/2]

bool HPS::ShellKey::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. Each index in the array must be such that in_vertices[i]<point_count for showing to succeed.
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.

ShowVertexParametersByRange() [1/2]

bool HPS::ShellKey::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 ShellKey at which to start showing texture parameters. This value must be such that in_start<point_count for showing to succeed.
in_count	The number of vertices for which to show the texture parameters. This value must be such that in_start+in_count<=point_count for the showing to succeed.
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.

ShowVertexParametersByRange() [2/2]

bool HPS::ShellKey::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 ShellKey at which to start showing texture parameters. This value must be such that in_start<point_count for showing to succeed.
in_count	The number of vertices for which to show the texture parameters. This value must be such that in_start+in_count<=point_count for the showing to succeed.
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.

ShowVertexVisibilities()

bool HPS::ShellKey::ShowVertexVisibilities	(	BoolArray &	out_validities,
		BoolArray &	out_visibilities
	)		const

Shows all the vertex visibilities on this ShellKey.

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.

ShowVertexVisibilitiesByList()

bool HPS::ShellKey::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. Each index in the array must be such that in_vertices[i]<point_count for showing to succeed.
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.

ShowVertexVisibilitiesByRange()

bool HPS::ShellKey::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 ShellKey at which to start showing visibilities. This value must be such that in_start<point_count for showing to succeed.
in_count	The number of visibilities to show. This value must be such that in_start+in_count<=point_count for the showing to succeed.
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.

Type()

virtual HPS::Type HPS::Object::Type ( ) const

virtualinherited

This function returns the true type of the underlying object.

This function is useful for finding the type of smart pointer objects that have been cast to more generic types.

Returns

The true type of the object in question.

Reimplemented in HPS::UpdateOptionsControl, HPS::HighlightControl, HPS::SelectionOptionsControl, HPS::OffScreenWindowOptionsControl, HPS::ApplicationWindowOptionsControl, HPS::StandAloneWindowOptionsControl, HPS::AttributeLockControl, HPS::WindowInfoControl, HPS::DebuggingControl, HPS::SubwindowControl, HPS::ContourLineControl, HPS::VisualEffectsControl, HPS::TransformMaskControl, HPS::PostProcessEffectsControl, HPS::DrawingAttributeControl, HPS::HiddenLineAttributeControl, HPS::PerformanceControl, HPS::NURBSSurfaceAttributeControl, HPS::ConditionControl, HPS::StyleControl, HPS::PortfolioControl, HPS::MaterialMappingControl, HPS::TextureMatrixControl, HPS::ModellingMatrixControl, HPS::CurveAttributeControl, HPS::EdgeAttributeControl, HPS::LineAttributeControl, HPS::TextAttributeControl, HPS::CuttingSectionAttributeControl, HPS::CylinderAttributeControl, HPS::LightingAttributeControl, HPS::SphereAttributeControl, HPS::MarkerAttributeControl, HPS::CullingControl, HPS::ColorInterpolationControl, HPS::TransparencyControl, HPS::SelectabilityControl, HPS::CameraControl, HPS::VisibilityControl, HPS::BoundingControl, HPS::Kit, and HPS::Control.

UnsetAllUserData()

GeometryKey& HPS::GeometryKey::UnsetAllUserData ( )

inherited

Removes all user data from this key.

Returns

A reference to this key.

UnsetEdgeColors()

ShellKey& HPS::ShellKey::UnsetEdgeColors

(

)

Unsets edge colors on all edges.

Parameters

in_vertices1	The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2	The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
out_types	The types of edge colors for each edge.
out_rgb_colors	The colors that have been set on each edge. A given element of this array is valid only if the equivalent element of out_types is Material::Type::RGBColor.
out_indices	The colors that have been set on each edge. A given element of this array is valid only if the equivalent element of out_types is Material::Type::MaterialIndex.

Returns

A reference to this ShellKey.

UnsetEdgeColorsByList() [1/2]

ShellKey& HPS::ShellKey::UnsetEdgeColorsByList	(	SizeTArray const &	in_vertices1,
		SizeTArray const &	in_vertices2
	)

Unsets edge colors on a selection of arbitrary edges.

Parameters

in_vertices1	The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2	The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.

Returns

A reference to this ShellKey.

UnsetEdgeColorsByList() [2/2]

ShellKey& HPS::ShellKey::UnsetEdgeColorsByList	(	size_t	in_count,
		size_t const	in_vertices1[],
		size_t const	in_vertices2[]
	)

Unsets edge colors on a selection of arbitrary edges.

Parameters

in_count	Size of the following arrays.
in_vertices1	The vertex indices that correspond to the start position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2	The vertex indices that correspond to the end position of each edge for which the visibilities are being changed. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.

Returns

A reference to this ShellKey.

UnsetEdgeEverything()

ShellKey& HPS::ShellKey::UnsetEdgeEverything

(

)

Removes all edge settings (edge colors and edge visibilities) from this ShellKey.

Returns

A reference to this ShellKey.

UnsetEdgeVisibilities()

ShellKey& HPS::ShellKey::UnsetEdgeVisibilities

(

)

Removes all vertex visibilities.

Returns

A reference to this ShellKey.

UnsetEdgeVisibilitiesByList() [1/2]

ShellKey& HPS::ShellKey::UnsetEdgeVisibilitiesByList	(	SizeTArray const &	in_vertices1,
		SizeTArray const &	in_vertices2
	)

Unsets edge visibilities on a selection of arbitrary edges.

Parameters

in_vertices1	The vertex indices that correspond to the start position of each edge for which the visibilities are being unset. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2	The vertex indices that correspond to the end position of each edge for which the visibilities are being unset. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.

Returns

A reference to this ShellKey.

UnsetEdgeVisibilitiesByList() [2/2]

ShellKey& HPS::ShellKey::UnsetEdgeVisibilitiesByList	(	size_t	in_count,
		size_t const	in_vertices1[],
		size_t const	in_vertices2[]
	)

Unsets edge visibilities on a selection of arbitrary edges.

Parameters

in_count	Size of the following arrays.
in_vertices1	The vertex indices that correspond to the start position of each edge for which the visibilities are being unset. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_vertices2	The vertex indices that correspond to the end position of each edge for which the visibilities are being unset. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.

Returns

A reference to this ShellKey.

UnsetEverything()

ShellKey& HPS::ShellKey::UnsetEverything

(

)

Removes all settings from this ShellKey.

Returns

A reference to this ShellKey.

UnsetFaceColors()

ShellKey& HPS::ShellKey::UnsetFaceColors

(

)

Removes all face colors (RGB colors or material indices).

Returns

A reference to this ShellKey.

UnsetFaceColorsByList() [1/2]

ShellKey& HPS::ShellKey::UnsetFaceColorsByList

(

SizeTArray const &

in_vertices

)

Removes the face colors (RGB colors or material indices) on a selection of arbitrary vertices.

Parameters

in_vertices

The indices of the faces on which to remove the colors. Each index in the array must be such that in_faces[i]<face_count for removal to succeed.

Returns

A reference to this ShellKey.

UnsetFaceColorsByList() [2/2]

ShellKey& HPS::ShellKey::UnsetFaceColorsByList	(	size_t	in_count,
		size_t const	in_faces[]
	)

Removes the face visibilities on a selection of arbitrary faces.

Parameters

in_count	The number of face visibilities to remove for this ShellKey.
in_faces	The indices of the faces on which to remove the visibilities.

Returns

A reference to this ShellKey.

UnsetFaceColorsByRange()

ShellKey& HPS::ShellKey::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 ShellKey at which to start removing colors. This value must be such that in_start<face_count for removal to succeed.
in_count	The number of face colors to remove for this ShellKey. This value must be such that in_start+in_count<=face_count for the removal to succeed.

Returns

A reference to this ShellKey.

UnsetFaceEverything()

ShellKey& HPS::ShellKey::UnsetFaceEverything

(

)

Removes all face settings (face colors, face normals, and face visibilities) from this ShellKey.

Returns

A reference to this ShellKey.

UnsetFacelist()

ShellKey& HPS::ShellKey::UnsetFacelist

(

)

Removes the face list for this ShellKey.

Returns

A reference to this ShellKey.

UnsetFaceNormals()

ShellKey& HPS::ShellKey::UnsetFaceNormals

(

)

Removes all face normals.

Returns

A reference to this ShellKey.

UnsetFaceNormalsByList()

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_faces[i]<face_count for removal to succeed.

Returns

A reference to this ShellKey.

UnsetFaceNormalsByRange()

ShellKey& HPS::ShellKey::UnsetFaceNormalsByRange	(	size_t	in_start,
		size_t	in_count
	)

Removes the specified range of face normals starting at the specified offset.

Parameters

in_start	The offset into the faces for this ShellKey at which to start removing normals. This value must be such that in_start<face_count for removal to succeed.
in_count	The number of face normals to remove for this ShellKey. This value must be such that in_start+in_count<=face_count for the removal to succeed.

Returns

A reference to this ShellKey.

UnsetFaceVisibilities()

ShellKey& HPS::ShellKey::UnsetFaceVisibilities

(

)

Removes all face visibilities.

Returns

A reference to this ShellKey.

UnsetFaceVisibilitiesByList() [1/2]

ShellKey& HPS::ShellKey::UnsetFaceVisibilitiesByList	(	size_t	in_count,
		size_t const	in_faces[]
	)

Removes the face visibilities on a selection of arbitrary faces.

Parameters

in_count	The number of face visibilities to remove for this ShellKey.
in_faces	The indices of the faces on which to remove the visibilities.

Returns

A reference to this ShellKey.

UnsetFaceVisibilitiesByList() [2/2]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_faces[i]<face_count for removal to succeed.

Returns

A reference to this ShellKey.

UnsetFaceVisibilitiesByRange()

ShellKey& HPS::ShellKey::UnsetFaceVisibilitiesByRange	(	size_t	in_start,
		size_t	in_count
	)

Removes the specified range of face visibilities starting at the specified offset.

Parameters

in_start	The offset into the faces for this ShellKey at which to start removing visibilities. This value must be such that in_start<face_count for removal to succeed.
in_count	The number of face visibilities to remove for this ShellKey. This value must be such that in_start+in_count<=face_count for the removal to succeed.

Returns

A reference to this ShellKey.

UnsetMaterialMapping()

ShellKey& HPS::ShellKey::UnsetMaterialMapping

(

)

Removes all material mappings on this ShellKey.

This removes the "global" material settings and does not affect per-vertex or per-face materials.

Returns

A reference to this ShellKey.

UnsetPoints()

ShellKey& HPS::ShellKey::UnsetPoints

(

)

Removes the points for this ShellKey.

Returns

A reference to this ShellKey.

UnsetPriority()

GeometryKey& HPS::GeometryKey::UnsetPriority ( )

inherited

Removes the drawing priority setting.

Returns

A reference to this object.

UnsetTristrips()

ShellKey& HPS::ShellKey::UnsetTristrips

(

)

Removes the tristrips list for this ShellKey.

Returns

A reference to this ShellKey.

UnsetUserData() [1/3]

GeometryKey& HPS::GeometryKey::UnsetUserData ( intptr_t  in_index )

inherited

Removes the user data at the given index from this key.

Parameters

in_index

The index of the user data to remove.

Returns

A reference to this key.

UnsetUserData() [2/3]

GeometryKey& HPS::GeometryKey::UnsetUserData ( size_t  in_count, intptr_t const  in_indices[]  )

inherited

Removes the user data at the given indices from this key.

Parameters

in_count	The size of the following array.
in_indices	The indices of the user data to remove.

Returns

A reference to this key.

UnsetUserData() [3/3]

GeometryKey& HPS::GeometryKey::UnsetUserData ( IntPtrTArray const &  in_indices )

inherited

Removes the user data at the given indices from this key.

Parameters

in_indices

The indices of the user data to remove.

Returns

A reference to this key.

UnsetVertexColors() [1/2]

ShellKey& HPS::ShellKey::UnsetVertexColors

(

)

Removes all vertex colors (RGB colors, RGBA colors, or material indices) for all shell components.

Returns

A reference to this ShellKey.

UnsetVertexColors() [2/2]

ShellKey& HPS::ShellKey::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 ShellKey.

UnsetVertexColorsByList() [1/4]

ShellKey& HPS::ShellKey::UnsetVertexColorsByList	(	size_t	in_count,
		size_t const	in_vertices[]
	)

Removes the vertex visibilities on a selection of arbitrary vertices.

Parameters

in_count	The number of vertex visibilities to remove for this ShellKey.
in_faces	The indices of the vertices on which to remove the visibilities.

Returns

A reference to this ShellKey.

UnsetVertexColorsByList() [2/4]

ShellKey& HPS::ShellKey::UnsetVertexColorsByList	(	size_t	in_count,
		size_t const	in_vertices[],
		Shell::Component	in_apply_to
	)

Removes the vertex visibilities on a selection of arbitrary vertices.

Parameters

in_count	The number of vertex visibilities to remove for this ShellKey.
in_faces	The indices of the vertices on which to remove the visibilities.
in_apply_to	The shell component the colors should apply to.

Returns

A reference to this ShellKey.

UnsetVertexColorsByList() [3/4]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_vertices[i]<point_count for removal to succeed.

Returns

A reference to this ShellKey.

UnsetVertexColorsByList() [4/4]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_vertices[i]<point_count for removal to succeed.
in_apply_to	The shell component for which to remove the colors.

Returns

A reference to this ShellKey.

UnsetVertexColorsByRange() [1/2]

ShellKey& HPS::ShellKey::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 ShellKey at which to start removing colors. This value must be such that in_start<point_count for removal to succeed.
in_count	The number of vertex colors to remove for this ShellKey. This value must be such that in_start+in_count<=point_count for the removal to succeed.

Returns

A reference to this ShellKey.

UnsetVertexColorsByRange() [2/2]

ShellKey& HPS::ShellKey::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 ShellKey at which to start removing colors. This value must be such that in_start<point_count for removal to succeed.
in_count	The number of vertex colors to remove for this ShellKey. This value must be such that in_start+in_count<=point_count for the removal to succeed.
in_apply_to	The shell component for which to remove the colors.

Returns

A reference to this ShellKey.

UnsetVertexEverything()

ShellKey& HPS::ShellKey::UnsetVertexEverything

(

)

Removes all vertex settings (vertex colors, vertex normals, texture parameters, and vertex visibilities) from this ShellKey.

Returns

A reference to this ShellKey.

UnsetVertexNormals()

ShellKey& HPS::ShellKey::UnsetVertexNormals

(

)

Removes all vertex normals.

Returns

A reference to this ShellKey.

UnsetVertexNormalsByList()

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_vertices[i]<point_count for removal to succeed.

Returns

A reference to this ShellKey.

UnsetVertexNormalsByRange()

ShellKey& HPS::ShellKey::UnsetVertexNormalsByRange	(	size_t	in_start,
		size_t	in_count
	)

Removes the specified range of vertex normals starting at the specified offset.

Parameters

in_start	The offset into the vertices for this ShellKey at which to start removing normals. This value must be such that in_start<point_count for removal to succeed.
in_count	The number of vertex normals to remove for this ShellKey. This value must be such that in_start+in_count<=point_count for the removal to succeed.

Returns

A reference to this ShellKey.

UnsetVertexParameters()

ShellKey& HPS::ShellKey::UnsetVertexParameters

(

)

Removes all texture parameters.

Returns

A reference to this ShellKey.

UnsetVertexParametersByList()

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_vertices[i]<point_count for removal to succeed.

Returns

A reference to this ShellKey.

UnsetVertexParametersByRange()

ShellKey& HPS::ShellKey::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 ShellKey at which to start removing texture parameters. This value must be such that in_start<point_count for removal to succeed.
in_count	The number of texture parameters to remove for this ShellKey. This value must be such that in_start+in_count<=point_count for the removal to succeed.

Returns

A reference to this ShellKey.

UnsetVertexVisibilities()

ShellKey& HPS::ShellKey::UnsetVertexVisibilities

(

)

Removes all vertex visibilities.

Returns

A reference to this ShellKey.

UnsetVertexVisibilitiesByList() [1/2]

ShellKey& HPS::ShellKey::UnsetVertexVisibilitiesByList	(	size_t	in_count,
		size_t const	in_vertices[]
	)

Removes the vertex visibilities on a selection of arbitrary vertices.

Parameters

in_count	The number of vertex visibilities to remove for this ShellKey.
in_faces	The indices of the vertices on which to remove the visibilities.

Returns

A reference to this ShellKey.

UnsetVertexVisibilitiesByList() [2/2]

ShellKey& HPS::ShellKey::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. Each index in the array must be such that in_vertices[i]<point_count for removal to succeed.

Returns

A reference to this ShellKey.

UnsetVertexVisibilitiesByRange()

ShellKey& HPS::ShellKey::UnsetVertexVisibilitiesByRange	(	size_t	in_start,
		size_t	in_count
	)

Removes the specified range of vertex visibilities starting at the specified offset.

Parameters

in_start	The offset into the vertices for this ShellKey at which to start removing visibilities. This value must be such that in_start<point_count for removal to succeed.
in_count	The number of vertex visibilities to remove for this ShellKey. This value must be such that in_start+in_count<=point_count for the removal to succeed.

Returns

A reference to this ShellKey.

Up()

SegmentKey HPS::Key::Up ( ) const

inherited

Returns

The segment containing this key.

Member Data Documentation

staticType

const HPS::Type HPS::ShellKey::staticType = HPS::Type::ShellKey

static

---

The documentation for this class was generated from the following file:

• hps.h