HPS::MeshKey Class Reference

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

#include <hps.h>

Inheritance diagram for HPS::MeshKey:

Collaboration diagram for HPS::MeshKey:

Public Member Functions
	MeshKey ()
	The default constructor creates an uninitialized MeshKey object. More...
	MeshKey (Key const &in_that)
	This constructor creates an MeshKey object that shares the underlying smart-pointer of the source Key. More...
	MeshKey (MeshKey const &in_that)
	The copy constructor creates a MeshKey object that shares the underlying smart-pointer of the source MeshKey. More...
MeshKey &	operator= (MeshKey const &in_that)
	Associate this MeshKey with the same underlying impl as the source MeshKey. More...
	MeshKey (MeshKey &&in_that)
	The move constructor creates a MeshKey by transferring the underlying impl of the rvalue reference to this MeshKey thereby avoiding a copy and allocation. More...
MeshKey &	operator= (MeshKey &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this MeshKey thereby avoiding a copy. More...
	~MeshKey ()
HPS::Type	ObjectType () const
void	Consume (MeshKit &in_kit)
	Completely replaces all settings on this MeshKey with those set on the specified kit and resets the kit. More...
void	Set (MeshKit const &in_kit)
	Replace those settings on this MeshKey with those set on the specified kit. More...
void	Show (MeshKit &out_kit) const
	Copy the contents of this MeshKey into the specified kit. More...
size_t	GetPointCount () const
	Retrieves the number of points in this mesh. More...
MeshKey &	SetPoints (size_t in_rows, size_t in_columns, PointArray const &in_points)
	Replace the points on this MeshKey with the specified points. More...
MeshKey &	SetPoints (size_t in_rows, size_t in_columns, size_t in_count, Point const in_points [])
	Replace the points on this MeshKey with the specified points. More...
bool	ShowPoints (PointArray &out_points) const
	Show the points for this MeshKey. More...
bool	ShowPointsByRange (size_t in_start_index, size_t in_count, PointArray &out_points) const
	Show a subset of the points for this MeshKey by range. More...
bool	ShowPointsByList (SizeTArray const &in_indices, PointArray &out_points) const
	Show a subset of the points for this MeshKey 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 MeshKey by list. More...
bool	ShowPoints (size_t &out_rows, size_t &out_columns, PointArray &out_points) const
	Show the number of rows, number of columns, and points for this MeshKey. More...
bool	ShowRows (size_t &out_rows) const
	Show the number of rows for this MeshKey. More...
bool	ShowColumns (size_t &out_columns) const
	Show the number of columns for this MeshKey. More...
MeshKey &	SetMaterialMapping (MaterialMappingKit const &in_kit)
	Sets the specified material mappings on this MeshKey. More...
MeshKey &	UnsetMaterialMapping ()
	Removes all material mappings on this MeshKey. More...
bool	ShowMaterialMapping (MaterialMappingKit &out_kit) const
	Shows the material mappings set on this MeshKey. More...
MeshKey &	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...
MeshKey &	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...
MeshKey &	SetEdgeVisibilitiesByList (SizeTArray const &in_vertices1, SizeTArray const &in_vertices2, bool in_visibility)
	Sets edge visibilities on a selection of arbitrary edges. More...
MeshKey &	SetEdgeVisibilitiesByList (SizeTArray const &in_vertices1, SizeTArray const &in_vertices2, BoolArray const &in_visibilities)
	Sets edge visibilities on a selection of arbitrary edges. More...
MeshKey &	SetEdgeIndexColorsByList (SizeTArray const &in_vertices1, SizeTArray const &in_vertices2, FloatArray const &in_indices)
	Sets edge material indices on a selection of arbitrary edges. More...
MeshKey &	SetEdgeIndexColorsByList (SizeTArray const &in_vertices1, SizeTArray const &in_vertices2, float in_index)
	Sets edge material indices on a selection of arbitrary edges. More...
MeshKey &	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...
MeshKey &	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...
MeshKey &	SetEdgeRGBColorsByList (SizeTArray const &in_vertices1, SizeTArray const &in_vertices2, RGBColorArray const &in_rgb_colors)
	Sets edge colors on a selection of arbitrary edges. More...
MeshKey &	SetEdgeRGBColorsByList (SizeTArray const &in_vertices1, SizeTArray const &in_vertices2, RGBColor const &in_rgb_color)
	Sets edge colors on a selection of arbitrary edges. More...
MeshKey &	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...
MeshKey &	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...
MeshKey &	UnsetEdgeColors ()
	Unsets edge colors on all edges. More...
MeshKey &	UnsetEdgeColorsByList (SizeTArray const &in_vertices1, SizeTArray const &in_vertices2)
	Unsets edge colors on a selection of arbitrary edges. More...
MeshKey &	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...
MeshKey &	UnsetEdgeVisibilities ()
	Removes all vertex visibilities. More...
MeshKey &	UnsetEdgeEverything ()
	Removes all edge settings (edge colors and edge visibilities) from this MeshKey. More...
MeshKey &	UnsetEdgeVisibilitiesByList (SizeTArray const &in_vertices1, SizeTArray const &in_vertices2)
	Unsets edge visibilities on a selection of arbitrary edges. More...
MeshKey &	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...
MeshKey &	SetVertexRGBColorsByRange (size_t in_start, size_t in_count, RGBColor const in_rgb_colors[], Mesh::Component in_apply_to=Mesh::Component::Faces)
	Sets vertex RGB colors on a range of vertices starting at the specified offset which apply to the specified mesh component. More...
MeshKey &	SetVertexRGBColorsByRange (size_t in_start, RGBColorArray const &in_rgb_colors, Mesh::Component in_apply_to=Mesh::Component::Faces)
	Sets vertex RGB colors on a range of vertices starting at the specified offset which apply to the specified mesh component. More...
MeshKey &	SetVertexRGBColorsByRange (size_t in_start, size_t in_count, RGBColor const &in_rgb_color, Mesh::Component in_apply_to=Mesh::Component::Faces)
	Sets a single RGB color on a range of vertices starting at the specified offset which apply to the specified mesh component. More...
MeshKey &	SetVertexRGBColorsByList (size_t in_count, size_t const in_vertices[], RGBColor const in_rgb_colors[], Mesh::Component in_apply_to=Mesh::Component::Faces)
	Sets vertex RGB colors on a selection of arbitrary vertices which apply to the specified mesh component. More...
MeshKey &	SetVertexRGBColorsByList (SizeTArray const &in_vertices, RGBColorArray const &in_rgb_colors, Mesh::Component in_apply_to=Mesh::Component::Faces)
	Sets vertex RGB colors on a selection of arbitrary vertices which apply to the specified mesh component. More...
MeshKey &	SetVertexRGBColorsByList (size_t in_count, size_t const in_vertices[], RGBColor const &in_rgb_color, Mesh::Component in_apply_to=Mesh::Component::Faces)
	Sets a single RGB color on a selection of arbitrary vertices which apply to the specified mesh component. More...
MeshKey &	SetVertexRGBColorsByList (SizeTArray const &in_vertices, RGBColor const &in_rgb_color, Mesh::Component in_apply_to=Mesh::Component::Faces)
	Sets a single RGB color on a selection of arbitrary vertices which apply to the specified mesh component. More...
MeshKey &	SetVertexRGBAColorsByRange (size_t in_start, size_t in_count, RGBAColor const in_rgba_colors[], Mesh::Component in_apply_to=Mesh::Component::Faces)
	Sets vertex RGBA colors on a range of vertices starting at the specified offset which apply to the specified mesh component. More...
MeshKey &	SetVertexRGBAColorsByRange (size_t in_start, RGBAColorArray const &in_rgba_colors, Mesh::Component in_apply_to=Mesh::Component::Faces)
	Sets vertex RGBA colors on a range of vertices starting at the specified offset which apply to the specified mesh component. More...
MeshKey &	SetVertexRGBAColorsByRange (size_t in_start, size_t in_count, RGBAColor const &in_rgba_color, Mesh::Component in_apply_to=Mesh::Component::Faces)
	Sets a single RGBA color on a range of vertices starting at the specified offset which apply to the specified mesh component. More...
MeshKey &	SetVertexRGBAColorsByList (size_t in_count, size_t const in_vertices[], RGBAColor const in_rgba_colors[], Mesh::Component in_apply_to=Mesh::Component::Faces)
	Sets vertex RGBA colors on a selection of arbitrary vertices which apply to the specified mesh component. More...
MeshKey &	SetVertexRGBAColorsByList (SizeTArray const &in_vertices, RGBAColorArray const &in_rgba_colors, Mesh::Component in_apply_to=Mesh::Component::Faces)
	Sets vertex RGBA colors on a selection of arbitrary vertices which apply to the specified mesh component. More...
MeshKey &	SetVertexRGBAColorsByList (size_t in_count, size_t const in_vertices[], RGBAColor const &in_rgba_color, Mesh::Component in_apply_to=Mesh::Component::Faces)
	Sets a single RGBA color on a selection of arbitrary vertices which apply to the specified mesh component. More...
MeshKey &	SetVertexRGBAColorsByList (SizeTArray const &in_vertices, RGBAColor const &in_rgba_color, Mesh::Component in_apply_to=Mesh::Component::Faces)
	Sets a single RGBA color on a selection of arbitrary vertices which apply to the specified mesh component. More...
MeshKey &	SetVertexIndexColorsByRange (size_t in_start, size_t in_count, float const in_indices[], Mesh::Component in_apply_to=Mesh::Component::Faces)
	Sets vertex material indices on a range of vertices starting at the specified offset which apply to the specified mesh component. More...
MeshKey &	SetVertexIndexColorsByRange (size_t in_start, FloatArray const &in_indices, Mesh::Component in_apply_to=Mesh::Component::Faces)
	Sets vertex material indices on a range of vertices starting at the specified offset which apply to the specified mesh component. More...
MeshKey &	SetVertexIndexColorsByRange (size_t in_start, size_t in_count, float in_index, Mesh::Component in_apply_to=Mesh::Component::Faces)
	Sets a single material index on a range of vertices starting at the specified offset which apply to the specified mesh component. More...
MeshKey &	SetVertexIndexColorsByList (size_t in_count, size_t const in_vertices[], float const in_indices[], Mesh::Component in_apply_to=Mesh::Component::Faces)
	Sets vertex material indices on a selection of arbitrary vertices which apply to the specified mesh component. More...
MeshKey &	SetVertexIndexColorsByList (SizeTArray const &in_vertices, FloatArray const &in_indices, Mesh::Component in_apply_to=Mesh::Component::Faces)
	Sets vertex material indices on a selection of arbitrary vertices which apply to the specified mesh component. More...
MeshKey &	SetVertexIndexColorsByList (size_t in_count, size_t const in_vertices[], float in_index, Mesh::Component in_apply_to=Mesh::Component::Faces)
	Sets a single material index on a selection of arbitrary vertices which apply to the specified mesh component. More...
MeshKey &	SetVertexIndexColorsByList (SizeTArray const &in_vertices, float in_index, Mesh::Component in_apply_to=Mesh::Component::Faces)
	Sets a single material index on a selection of arbitrary vertices which apply to the specified mesh component. More...
MeshKey &	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...
MeshKey &	SetVertexNormalsByRange (size_t in_start, VectorArray const &in_normals)
	Sets vertex normals on a range of vertices starting at the specified offset. More...
MeshKey &	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...
MeshKey &	SetVertexNormalsByList (size_t in_count, size_t const in_vertices[], Vector const in_normals[])
	Sets vertex normals on a selection of arbitrary vertices. More...
MeshKey &	SetVertexNormalsByList (SizeTArray const &in_vertices, VectorArray const &in_normals)
	Sets vertex normals on a selection of arbitrary vertices. More...
MeshKey &	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...
MeshKey &	SetVertexNormalsByList (SizeTArray const &in_vertices, Vector const &in_normal)
	Sets a single normal on a selection of arbitrary vertices. More...
MeshKey &	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...
MeshKey &	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...
MeshKey &	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...
MeshKey &	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...
MeshKey &	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...
MeshKey &	SetVertexVisibilitiesByRange (size_t in_start, BoolArray const &in_visibilities)
	Sets vertex visibilities on a range of vertices starting at the specified offset. More...
MeshKey &	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...
MeshKey &	SetVertexVisibilitiesByList (size_t in_count, size_t const in_vertices[], bool const in_visibilities[])
	Sets vertex visibilities on a selection of arbitrary vertices. More...
MeshKey &	SetVertexVisibilitiesByList (SizeTArray const &in_vertices, BoolArray const &in_visibilities)
	Sets vertex visibilities on a selection of arbitrary vertices. More...
MeshKey &	SetVertexVisibilitiesByList (size_t in_count, size_t const in_vertices[], bool in_visibility)
	Sets a single visibility on a selection of arbitrary vertices. More...
MeshKey &	SetVertexVisibilitiesByList (SizeTArray const &in_vertices, bool in_visibility)
	Sets a single visibility on a selection of arbitrary vertices. More...
MeshKey &	UnsetVertexColors ()
	Removes all vertex colors (RGB colors, RGBA colors, or material indices) for all mesh components. More...
MeshKey &	UnsetVertexVisibilitiesByList (size_t in_count, size_t const in_vertices[])
	Removes the vertex visibilities on a selection of arbitrary vertices. More...
MeshKey &	UnsetVertexColorsByList (size_t in_count, size_t const in_vertices[])
	Removes the vertex visibilities on a selection of arbitrary vertices. More...
MeshKey &	UnsetVertexColorsByList (size_t in_count, size_t const in_vertices[], Mesh::Component in_apply_to)
	Removes the vertex visibilities on a selection of arbitrary vertices. More...
MeshKey &	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 mesh components starting at the specified offset. More...
MeshKey &	UnsetVertexColorsByList (SizeTArray const &in_vertices)
	Removes the vertex colors (RGB colors, RGBA colors, or material indices) for all mesh components on a selection of arbitrary vertices. More...
MeshKey &	UnsetVertexColors (Mesh::Component in_apply_to)
	Removes all vertex colors (RGB colors, RGBA colors, or material indices) for the specified mesh component. More...
MeshKey &	UnsetVertexColorsByRange (size_t in_start, size_t in_count, Mesh::Component in_apply_to)
	Removes the specified range of vertex colors (RGB colors, RGBA colors, or material indices) for the specified mesh component starting at the specified offset. More...
MeshKey &	UnsetVertexColorsByList (SizeTArray const &in_vertices, Mesh::Component in_apply_to)
	Removes the vertex colors (RGB colors, RGBA colors, or material indices) for the specificed mesh component on a selection of arbitrary vertices. More...
MeshKey &	UnsetVertexNormals ()
	Removes all vertex normals. More...
MeshKey &	UnsetVertexNormalsByRange (size_t in_start, size_t in_count)
	Removes the specified range of vertex normals starting at the specified offset. More...
MeshKey &	UnsetVertexNormalsByList (SizeTArray const &in_vertices)
	Removes the vertex normals on a selection of arbitrary vertices. More...
MeshKey &	UnsetVertexParameters ()
	Removes all texture parameters. More...
MeshKey &	UnsetVertexParametersByRange (size_t in_start, size_t in_count)
	Removes the specified range of texture parameters starting at the specified offset. More...
MeshKey &	UnsetVertexParametersByList (SizeTArray const &in_vertices)
	Removes the texture parameters on a selection of arbitrary vertices. More...
MeshKey &	UnsetVertexVisibilities ()
	Removes all vertex visibilities. More...
MeshKey &	UnsetVertexVisibilitiesByRange (size_t in_start, size_t in_count)
	Removes the specified range of vertex visibilities starting at the specified offset. More...
MeshKey &	UnsetVertexVisibilitiesByList (SizeTArray const &in_vertices)
	Removes the vertex visibilities on a selection of arbitrary vertices. More...
MeshKey &	UnsetVertexEverything ()
	Removes all vertex settings (vertex colors, vertex normals, texture parameters, and vertex visibilities) from this MeshKey. More...
MeshKey &	UnsetEverything ()
	Removes all settings from this MeshKey. More...
bool	ShowVertexColors (Mesh::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 mesh component. More...
bool	ShowVertexColorsByRange (size_t in_start, size_t in_count, Mesh::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 mesh component. More...
bool	ShowVertexColorsByList (SizeTArray const &in_vertices, Mesh::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 mesh component. More...
bool	ShowVertexNormals (BoolArray &out_validities, VectorArray &out_normals) const
	Shows all the vertex normals on this MeshKey. 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 MeshKey. 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 the vertices in this MeshKey. More...
bool	ShowVertexParameters (BoolArray &out_validities, FloatArray &out_params, size_t &out_param_width) const
	Shows the texture parameters for all the vertices in this MeshKey. 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 MeshKey. 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...
MeshKey &	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...
MeshKey &	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...
MeshKey &	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...
MeshKey &	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...
MeshKey &	SetFaceRGBColorsByList (SizeTArray const &in_faces, RGBColorArray const &in_rgb_colors)
	Sets face RGB colors on a selection of arbitrary faces. More...
MeshKey &	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...
MeshKey &	SetFaceRGBColorsByList (SizeTArray const &in_faces, RGBColor const &in_rgb_color)
	Sets a single RGB color on a selection of arbitrary faces. More...
MeshKey &	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...
MeshKey &	SetFaceIndexColorsByRange (size_t in_start, FloatArray const &in_indices)
	Sets face material indices on a range of faces starting at the specified offset. More...
MeshKey &	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...
MeshKey &	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...
MeshKey &	SetFaceIndexColorsByList (SizeTArray const &in_faces, FloatArray const &in_indices)
	Sets face material indices on a selection of arbitrary faces. More...
MeshKey &	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...
MeshKey &	SetFaceIndexColorsByList (SizeTArray const &in_faces, float in_index)
	Sets a single material index on a selection of arbitrary faces. More...
MeshKey &	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...
MeshKey &	SetFaceNormalsByRange (size_t in_start, VectorArray const &in_normals)
	Sets face normals on a range of faces starting at the specified offset. More...
MeshKey &	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...
MeshKey &	SetFaceNormalsByList (size_t in_count, size_t const in_faces[], Vector const in_normals[])
	Sets face normals on a selection of arbitrary faces. More...
MeshKey &	SetFaceNormalsByList (SizeTArray const &in_faces, VectorArray const &in_normals)
	Sets face normals on a selection of arbitrary faces. More...
MeshKey &	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...
MeshKey &	SetFaceNormalsByList (SizeTArray const &in_faces, Vector const &in_normal)
	Sets a single normal on a selection of arbitrary faces. More...
MeshKey &	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...
MeshKey &	SetFaceVisibilitiesByRange (size_t in_start, BoolArray const &in_visibilities)
	Sets face visibilities on a range of faces starting at the specified offset. More...
MeshKey &	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...
MeshKey &	SetFaceVisibilitiesByList (size_t in_count, size_t const in_faces[], bool const in_visibilities[])
	Sets face visibilities on a selection of arbitrary faces. More...
MeshKey &	SetFaceVisibilitiesByList (SizeTArray const &in_faces, BoolArray const &in_visibilities)
	Sets face visibilities on a selection of arbitrary faces. More...
MeshKey &	SetFaceVisibilitiesByList (size_t in_count, size_t const in_faces[], bool in_visibility)
	Sets a single visibility on a selection of arbitrary faces. More...
MeshKey &	SetFaceVisibilitiesByList (SizeTArray const &in_faces, bool in_visibility)
	Sets a single visibility on a selection of arbitrary faces. More...
MeshKey &	UnsetFaceColors ()
	Removes all face colors (RGB colors or material indices). More...
MeshKey &	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...
MeshKey &	UnsetFaceColorsByList (SizeTArray const &in_faces)
	Removes the face colors (RGB colors or material indices) on a selection of arbitrary vertices. More...
MeshKey &	UnsetFaceVisibilitiesByList (size_t in_count, size_t const in_faces[])
	Removes the face visibilities on a selection of arbitrary faces. More...
MeshKey &	UnsetFaceColorsByList (size_t in_count, size_t const in_faces[])
	Removes the face visibilities on a selection of arbitrary faces. More...
MeshKey &	UnsetFaceNormals ()
	Removes all face normals. More...
MeshKey &	UnsetFaceNormalsByRange (size_t in_start, size_t in_count)
	Removes the specified range of face normals starting at the specified offset. More...
MeshKey &	UnsetFaceNormalsByList (SizeTArray const &in_faces)
	Removes the face normals on a selection of arbitrary faces. More...
MeshKey &	UnsetFaceVisibilities ()
	Removes all face visibilities. More...
MeshKey &	UnsetFaceVisibilitiesByRange (size_t in_start, size_t in_count)
	Removes the specified range of face visibilities starting at the specified offset. More...
MeshKey &	UnsetFaceVisibilitiesByList (SizeTArray const &in_faces)
	Removes the face visibilities on a selection of arbitrary faces. More...
MeshKey &	UnsetFaceEverything ()
	Removes all face settings (face colors, face normals, and face visibilities) from this MeshKey. More...
bool	ShowFaceColors (MaterialTypeArray &out_types, RGBColorArray &out_rgb_colors, FloatArray &out_indices) const
	Shows the face colors on MeshKey. 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 MeshKey. 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	ShowFaceVisibilities (BoolArray &out_validities, BoolArray &out_visibilities) const
	Shows all the face visibilities on this MeshKey. 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...
MeshKey &	EditMeshByReplacement (size_t in_row_offset, size_t in_column_offset, size_t in_row_count, size_t in_column_count, size_t in_point_count, Point const in_points[])
	Replaces a range of points for this MeshKey. More...
MeshKey &	EditMeshByReplacement (size_t in_row_offset, size_t in_column_offset, size_t in_row_count, size_t in_column_count, PointArray const &in_points)
	Replaces a range of points for this MeshKey. 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::MeshKey

Detailed Description

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

It is a handle to a mesh created by SegmentKey::InsertMesh.

Constructor & Destructor Documentation

MeshKey() [1/4]

HPS::MeshKey::MeshKey

(

)

The default constructor creates an uninitialized MeshKey object.

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

MeshKey() [2/4]

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

explicit

This constructor creates an MeshKey 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 mesh key. Otherwise the copy will fail and the resulting MeshKey will be invalid.

Parameters

in_that

The source Key to copy.

MeshKey() [3/4]

HPS::MeshKey::MeshKey

(

MeshKey const &

in_that

)

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

Parameters

in_that

The source MeshKey to copy.

MeshKey() [4/4]

HPS::MeshKey::MeshKey

(

MeshKey &&

in_that

)

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

Parameters

in_that

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

~MeshKey()

HPS::MeshKey::~MeshKey

(

)

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.

Consume()

void HPS::MeshKey::Consume

(

MeshKit &

in_kit

)

Completely replaces all settings on this MeshKey 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 MeshKey.

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.

EditMeshByReplacement() [1/2]

MeshKey& HPS::MeshKey::EditMeshByReplacement	(	size_t	in_row_offset,
		size_t	in_column_offset,
		size_t	in_row_count,
		size_t	in_column_count,
		size_t	in_point_count,
		Point const	in_points[]
	)

Replaces a range of points for this MeshKey.

Parameters

in_row_offset	The row offset into the MeshKey at which to start replacing points. This value must be such that in_row_offset<row_count for replacement to succeed.
in_column_offset	The column offset into the MeshKey at which to start replacing points. This value must be such that in_column_offset<column_count for replacement to succeed.
in_row_count	The number of rows to replace. This value must be such that in_row_offset+in_row_count<=row_count for replacement to succeed.
in_column_count	The number of columns to replace. This value must be such that in_column_offset+in_column_count<=column_count for replacement to succeed.
in_point_count	The size of the in_points array. The size of the array should be in_row_count*in_column_count.
in_points	The points to use to replace those in the specified range.

Returns

A reference to this MeshKey.

EditMeshByReplacement() [2/2]

MeshKey& HPS::MeshKey::EditMeshByReplacement	(	size_t	in_row_offset,
		size_t	in_column_offset,
		size_t	in_row_count,
		size_t	in_column_count,
		PointArray const &	in_points
	)

Replaces a range of points for this MeshKey.

Parameters

in_row_offset	The row offset into the MeshKey at which to start replacing points. This value must be such that in_row_offset<row_count for replacement to succeed.
in_column_offset	The column offset into the MeshKey at which to start replacing points. This value must be such that in_column_offset<column_count for replacement to succeed.
in_row_count	The number of rows to replace. This value must be such that in_row_offset+in_row_count<=row_count for replacement to succeed.
in_column_count	The number of columns to replace. This value must be such that in_column_offset+in_column_count<=column_count for replacement to succeed.
in_points	The points to use to replace those in the specified range. The size of the array should be in_row_count*in_column_count.

Returns

A reference to this MeshKey.

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.

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::MeshKey::GetPointCount

(

)

const

Retrieves the number of points in this mesh.

Returns

The number of points in this mesh.

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::MeshKey::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]

MeshKey& HPS::MeshKey::operator=

(

MeshKey const &

in_that

)

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

Parameters

in_that

The source MeshKey for the assignment.

Returns

A reference to this MeshKey.

operator=() [2/2]

MeshKey& HPS::MeshKey::operator=

(

MeshKey &&

in_that

)

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

Parameters

in_that

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

Returns

A reference to this MeshKey.

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.

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::MeshKey::Set

(

MeshKit const &

in_kit

)

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

Parameters

in_kit

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

SetEdgeIndexColorsByList() [1/4]

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

SetEdgeIndexColorsByList() [2/4]

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

SetEdgeIndexColorsByList() [3/4]

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

SetEdgeIndexColorsByList() [4/4]

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

SetEdgeRGBColorsByList() [1/4]

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

SetEdgeRGBColorsByList() [2/4]

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

SetEdgeRGBColorsByList() [3/4]

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

SetEdgeRGBColorsByList() [4/4]

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

SetEdgeVisibilitiesByList() [1/4]

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

SetEdgeVisibilitiesByList() [2/4]

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

SetEdgeVisibilitiesByList() [3/4]

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

SetEdgeVisibilitiesByList() [4/4]

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

SetFaceIndexColorsByList() [1/4]

MeshKey& HPS::MeshKey::SetFaceIndexColorsByList	(	size_t	in_count,
		size_t const	in_faces[],
		float const	in_indices[]
	)

Sets face material indices on a selection of arbitrary faces.

Parameters

in_count	Size of the following arrays.
in_faces	The indices of the faces on which to set the colors.
in_indices	The material indices to set on the faces.

Returns

A reference to this MeshKey.

SetFaceIndexColorsByList() [2/4]

MeshKey& HPS::MeshKey::SetFaceIndexColorsByList	(	SizeTArray const &	in_faces,
		FloatArray const &	in_indices
	)

Sets face material indices on a selection of arbitrary faces.

If the sizes of the face index and material index arrays are different, the smaller size will be used.

Parameters

in_faces	The indices of the faces on which to set the colors.
in_indices	The material indices to set on the faces.

Returns

A reference to this MeshKey.

SetFaceIndexColorsByList() [3/4]

MeshKey& HPS::MeshKey::SetFaceIndexColorsByList	(	size_t	in_count,
		size_t const	in_faces[],
		float	in_index
	)

Sets a single material index on a selection of arbitrary faces.

Parameters

in_count	Size of the following array.
in_faces	The indices of the faces on which to set the color.
in_index	The material index to set on the faces.

Returns

A reference to this MeshKey.

SetFaceIndexColorsByList() [4/4]

MeshKey& HPS::MeshKey::SetFaceIndexColorsByList	(	SizeTArray const &	in_faces,
		float	in_index
	)

Sets a single material index on a selection of arbitrary faces.

Parameters

in_faces	The indices of the faces on which to set the color.
in_index	The material index to set on the faces.

Returns

A reference to this MeshKey.

SetFaceIndexColorsByRange() [1/3]

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

Returns

A reference to this MeshKey.

SetFaceIndexColorsByRange() [2/3]

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

SetFaceIndexColorsByRange() [3/3]

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

Returns

A reference to this MeshKey.

SetFaceNormalsByList() [1/4]

MeshKey& HPS::MeshKey::SetFaceNormalsByList	(	size_t	in_count,
		size_t const	in_faces[],
		Vector const	in_normals[]
	)

Sets face normals on a selection of arbitrary faces.

Parameters

in_count	Size of the following arrays.
in_faces	The indices of the faces on which to set the normals.
in_normals	The normals to set on the faces.

Returns

A reference to this MeshKey.

SetFaceNormalsByList() [2/4]

MeshKey& HPS::MeshKey::SetFaceNormalsByList	(	SizeTArray const &	in_faces,
		VectorArray const &	in_normals
	)

Sets face normals on a selection of arbitrary faces.

If the sizes of the face index and normal arrays are different, the smaller size will be used.

Parameters

in_faces	The indices of the faces on which to set the normals.
in_normals	The normals to set on the faces.

Returns

A reference to this MeshKey.

SetFaceNormalsByList() [3/4]

MeshKey& HPS::MeshKey::SetFaceNormalsByList	(	size_t	in_count,
		size_t const	in_faces[],
		Vector const &	in_normal
	)

Sets a single normal on a selection of arbitrary faces.

Parameters

in_count	Size of the following array.
in_faces	The indices of the faces on which to set the normal.
in_normal	The normal to set on the faces.

Returns

A reference to this MeshKey.

SetFaceNormalsByList() [4/4]

MeshKey& HPS::MeshKey::SetFaceNormalsByList	(	SizeTArray const &	in_faces,
		Vector const &	in_normal
	)

Sets a single normal on a selection of arbitrary faces.

Parameters

in_faces	The indices of the faces on which to set the normal.
in_normal	The normal to set on the faces.

Returns

A reference to this MeshKey.

SetFaceNormalsByRange() [1/3]

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

Returns

A reference to this MeshKey.

SetFaceNormalsByRange() [2/3]

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

SetFaceNormalsByRange() [3/3]

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

Returns

A reference to this MeshKey.

SetFaceRGBColorsByList() [1/4]

MeshKey& HPS::MeshKey::SetFaceRGBColorsByList	(	size_t	in_count,
		size_t const	in_faces[],
		RGBColor const	in_rgb_colors[]
	)

Sets face RGB colors on a selection of arbitrary faces.

Parameters

in_count	Size of the following arrays.
in_faces	The indices of the faces on which to set the colors.
in_rgb_colors	The RGB colors to set on the faces.

Returns

A reference to this MeshKey.

SetFaceRGBColorsByList() [2/4]

MeshKey& HPS::MeshKey::SetFaceRGBColorsByList	(	SizeTArray const &	in_faces,
		RGBColorArray const &	in_rgb_colors
	)

Sets face RGB colors on a selection of arbitrary faces.

If the sizes of the face index array and the color array different, the smaller size will be used.

Parameters

in_faces	The indices of the faces on which to set the colors.
in_rgb_colors	The RGB colors to set on the faces.

Returns

A reference to this MeshKey.

SetFaceRGBColorsByList() [3/4]

MeshKey& HPS::MeshKey::SetFaceRGBColorsByList	(	size_t	in_count,
		size_t const	in_faces[],
		RGBColor const &	in_rgb_color
	)

Sets a single RGB color on a selection of arbitrary faces.

Parameters

in_count	Size of the following array.
in_faces	The indices of the faces on which to set the color.
in_rgb_color	The RGB color to set on the faces.

Returns

A reference to this MeshKey.

SetFaceRGBColorsByList() [4/4]

MeshKey& HPS::MeshKey::SetFaceRGBColorsByList	(	SizeTArray const &	in_faces,
		RGBColor const &	in_rgb_color
	)

Sets a single RGB color on a selection of arbitrary faces.

Parameters

in_faces	The indices of the faces on which to set the color.
in_rgb_color	The RGB color to set on the faces.

Returns

A reference to this MeshKey.

SetFaceRGBColorsByRange() [1/3]

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

Returns

A reference to this MeshKey.

SetFaceRGBColorsByRange() [2/3]

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

SetFaceRGBColorsByRange() [3/3]

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

Returns

A reference to this MeshKey.

SetFaceVisibilitiesByList() [1/4]

MeshKey& HPS::MeshKey::SetFaceVisibilitiesByList	(	size_t	in_count,
		size_t const	in_faces[],
		bool const	in_visibilities[]
	)

Sets face visibilities on a selection of arbitrary faces.

Parameters

in_count	Size of the following arrays.
in_faces	The indices of the faces on which to set the visibilities.
in_visibilities	The visibilities to set on the faces.

Returns

A reference to this MeshKey.

SetFaceVisibilitiesByList() [2/4]

MeshKey& HPS::MeshKey::SetFaceVisibilitiesByList	(	SizeTArray const &	in_faces,
		BoolArray const &	in_visibilities
	)

Sets face visibilities on a selection of arbitrary faces.

If the sizes of the face index and visibility arrays are different, the smaller size will be used.

Parameters

in_faces	The indices of the faces on which to set the visibilities.
in_visibilities	The visibilities to set on the faces.

Returns

A reference to this MeshKey.

SetFaceVisibilitiesByList() [3/4]

MeshKey& HPS::MeshKey::SetFaceVisibilitiesByList	(	size_t	in_count,
		size_t const	in_faces[],
		bool	in_visibility
	)

Sets a single visibility on a selection of arbitrary faces.

Parameters

in_count	Size of the following array.
in_faces	The indices of the faces on which to set the visibility.
in_visibility	The visibility to set on the faces.

Returns

A reference to this MeshKey.

SetFaceVisibilitiesByList() [4/4]

MeshKey& HPS::MeshKey::SetFaceVisibilitiesByList	(	SizeTArray const &	in_faces,
		bool	in_visibility
	)

Sets a single visibility on a selection of arbitrary faces.

Parameters

in_faces	The indices of the faces on which to set the visibility.
in_visibility	The visibility to set on the faces.

Returns

A reference to this MeshKey.

SetFaceVisibilitiesByRange() [1/3]

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

Returns

A reference to this MeshKey.

SetFaceVisibilitiesByRange() [2/3]

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

SetFaceVisibilitiesByRange() [3/3]

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

Returns

A reference to this MeshKey.

SetMaterialMapping()

MeshKey& HPS::MeshKey::SetMaterialMapping

(

MaterialMappingKit const &

in_kit

)

Sets the specified material mappings on this MeshKey.

Only face, back face, cut edge, cut face, edge, and vertex materials will be set on the mesh. These material settings will be "global" for the mesh, 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 MeshKey.

Returns

A reference to this MeshKey.

SetPoints() [1/2]

MeshKey& HPS::MeshKey::SetPoints	(	size_t	in_rows,
		size_t	in_columns,
		PointArray const &	in_points
	)

Replace the points on this MeshKey with the specified points.

Parameters

in_rows	The number of rows for this MeshKey.
in_columns	The number of columns for this MeshKey.
in_points	The points to use to replace those on this MeshKey.

Returns

A reference to this MeshKey.

SetPoints() [2/2]

MeshKey& HPS::MeshKey::SetPoints	(	size_t	in_rows,
		size_t	in_columns,
		size_t	in_count,
		Point const	in_points[]
	)

Replace the points on this MeshKey with the specified points.

Parameters

in_rows	The number of rows for this MeshKey.
in_columns	The number of columns for this MeshKey.
in_count	Size of the following array.
in_points	The points to use to replace those on this MeshKey.

Returns

A reference to this MeshKey.

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

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]

MeshKey& HPS::MeshKey::SetVertexIndexColorsByList	(	size_t	in_count,
		size_t const	in_vertices[],
		float const	in_indices[],
		Mesh::Component	in_apply_to = Mesh::Component::Faces
	)

Sets vertex material indices on a selection of arbitrary vertices which apply to the specified mesh 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 mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

SetVertexIndexColorsByList() [2/4]

MeshKey& HPS::MeshKey::SetVertexIndexColorsByList	(	SizeTArray const &	in_vertices,
		FloatArray const &	in_indices,
		Mesh::Component	in_apply_to = Mesh::Component::Faces
	)

Sets vertex material indices on a selection of arbitrary vertices which apply to the specified mesh component.

If the sizes of the vertex index and material index arrays are different, the smaller size will be used.

Parameters

in_vertices	The indices of the vertices on which to set the colors.
in_indices	The material indices to set on the vertices.
in_apply_to	The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

SetVertexIndexColorsByList() [3/4]

MeshKey& HPS::MeshKey::SetVertexIndexColorsByList	(	size_t	in_count,
		size_t const	in_vertices[],
		float	in_index,
		Mesh::Component	in_apply_to = Mesh::Component::Faces
	)

Sets a single material index on a selection of arbitrary vertices which apply to the specified mesh component.

Parameters

in_count	Size of the following array.
in_vertices	The indices of the vertices on which to set the color.
in_index	The material index to set on the vertices.
in_apply_to	The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

SetVertexIndexColorsByList() [4/4]

MeshKey& HPS::MeshKey::SetVertexIndexColorsByList	(	SizeTArray const &	in_vertices,
		float	in_index,
		Mesh::Component	in_apply_to = Mesh::Component::Faces
	)

Sets a single material index on a selection of arbitrary vertices which apply to the specified mesh component.

Parameters

in_vertices	The indices of the vertices on which to set the color.
in_index	The material index to set on the vertices.
in_apply_to	The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

SetVertexIndexColorsByRange() [1/3]

MeshKey& HPS::MeshKey::SetVertexIndexColorsByRange	(	size_t	in_start,
		size_t	in_count,
		float const	in_indices[],
		Mesh::Component	in_apply_to = Mesh::Component::Faces
	)

Sets vertex material indices on a range of vertices starting at the specified offset which apply to the specified mesh component.

Parameters

in_start	The offset into the vertices for this MeshKey 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<=vertex_count for the setting to succeed.
in_indices	The material indices to set on the vertices for this MeshKey.
in_apply_to	The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

SetVertexIndexColorsByRange() [2/3]

MeshKey& HPS::MeshKey::SetVertexIndexColorsByRange	(	size_t	in_start,
		FloatArray const &	in_indices,
		Mesh::Component	in_apply_to = Mesh::Component::Faces
	)

Sets vertex material indices on a range of vertices starting at the specified offset which apply to the specified mesh component.

Parameters

in_start	The offset into the vertices for this MeshKey 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 MeshKey. The size of the array must be such that in_start+in_indices.size()<=vertex_count for the setting to succeed.
in_apply_to	The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

SetVertexIndexColorsByRange() [3/3]

MeshKey& HPS::MeshKey::SetVertexIndexColorsByRange	(	size_t	in_start,
		size_t	in_count,
		float	in_index,
		Mesh::Component	in_apply_to = Mesh::Component::Faces
	)

Sets a single material index on a range of vertices starting at the specified offset which apply to the specified mesh component.

Parameters

in_start	The offset into the vertices for this MeshKey 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<=vertex_count for the setting to succeed.
in_index	The material index to set on the vertices for this MeshKey.
in_apply_to	The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

SetVertexNormalsByList() [1/4]

MeshKey& HPS::MeshKey::SetVertexNormalsByList	(	size_t	in_count,
		size_t const	in_vertices[],
		Vector const	in_normals[]
	)

Sets vertex normals on a selection of arbitrary vertices.

Parameters

in_count	Size of the following arrays.
in_vertices	The indices of the vertices on which to set the normals.
in_normals	The normals to set on the vertices.

Returns

A reference to this MeshKey.

SetVertexNormalsByList() [2/4]

MeshKey& HPS::MeshKey::SetVertexNormalsByList	(	SizeTArray const &	in_vertices,
		VectorArray const &	in_normals
	)

Sets vertex normals on a selection of arbitrary vertices.

If the sizes of the vertex index and normal arrays are different, the smaller size will be used.

Parameters

in_vertices	The indices of the vertices on which to set the normals.
in_normals	The normals to set on the vertices.

Returns

A reference to this MeshKey.

SetVertexNormalsByList() [3/4]

MeshKey& HPS::MeshKey::SetVertexNormalsByList	(	size_t	in_count,
		size_t const	in_vertices[],
		Vector const &	in_normal
	)

Sets a single normal on a selection of arbitrary vertices.

Parameters

in_count	Size of the following array.
in_vertices	The indices of the vertices on which to set the normal.
in_normal	The normal to set on the vertices.

Returns

A reference to this MeshKey.

SetVertexNormalsByList() [4/4]

MeshKey& HPS::MeshKey::SetVertexNormalsByList	(	SizeTArray const &	in_vertices,
		Vector const &	in_normal
	)

Sets a single normal on a selection of arbitrary vertices.

Parameters

in_vertices	The indices of the vertices on which to set the normal.
in_normal	The normal to set on the vertices.

Returns

A reference to this MeshKey.

SetVertexNormalsByRange() [1/3]

MeshKey& HPS::MeshKey::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 MeshKey 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<=vertex_count for the setting to succeed.
in_normals	The normals to set on the vertices for this MeshKey.

Returns

A reference to this MeshKey.

SetVertexNormalsByRange() [2/3]

MeshKey& HPS::MeshKey::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 MeshKey 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 MeshKey. The size of the array must be such that in_start+in_normals.size()<=vertex_count for the setting to succeed.

Returns

A reference to this MeshKey.

SetVertexNormalsByRange() [3/3]

MeshKey& HPS::MeshKey::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 MeshKey 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<=vertex_count for the setting to succeed.
in_normal	The normal to set on the vertices for this MeshKey.

Returns

A reference to this MeshKey.

SetVertexParametersByList() [1/2]

MeshKey& HPS::MeshKey::SetVertexParametersByList	(	size_t	in_vertex_count,
		size_t const	in_vertices[],
		size_t	in_param_count,
		float const	in_params[],
		size_t	in_param_width = 2
	)

Sets texture parameters on a selection of arbitrary vertices.

If the sizes of the vertex index array and the texture paramter array (divided by the parameter width) are different, the smaller size will be used.

Parameters

in_vertex_count	Size of the following array.
in_vertices	The indices of the vertices on which to set the texture parameters.
in_param_count	Size of the following array. This should be divisible by the parameter width, if it is not, some parameters will get ignored.
in_params	The texture parameters to set on the vertices for this MeshKey.
in_param_width	The number of texture parameters per vertex. Defaults to 2.

Returns

A reference to this MeshKey.

SetVertexParametersByList() [2/2]

MeshKey& HPS::MeshKey::SetVertexParametersByList	(	SizeTArray const &	in_vertices,
		FloatArray const &	in_params,
		size_t	in_param_width = 2
	)

Sets texture parameters on a selection of arbitrary vertices.

If the sizes of the vertex index array and the texture paramter array (divided by the parameter width) are different, the smaller size will be used.

Parameters

in_vertices	The indices of the vertices on which to set the texture parameters.
in_params	The texture parameters to set on the vertices for this MeshKey. 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 MeshKey.

SetVertexParametersByRange() [1/2]

MeshKey& HPS::MeshKey::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 MeshKey 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 MeshKey.
in_param_width	The number of texture parameters per vertex. Defaults to 2.

Returns

A reference to this MeshKey.

SetVertexParametersByRange() [2/2]

MeshKey& HPS::MeshKey::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 MeshKey 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 MeshKey. The size of the array 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_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 MeshKey.

SetVertexRGBAColorsByList() [1/4]

MeshKey& HPS::MeshKey::SetVertexRGBAColorsByList	(	size_t	in_count,
		size_t const	in_vertices[],
		RGBAColor const	in_rgba_colors[],
		Mesh::Component	in_apply_to = Mesh::Component::Faces
	)

Sets vertex RGBA colors on a selection of arbitrary vertices which apply to the specified mesh component.

Parameters

in_count	Size of the following arrays.
in_vertices	The indices of the vertices on which to set the colors.
in_rgba_colors	The RGBA colors to set on the vertices.
in_apply_to	The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

SetVertexRGBAColorsByList() [2/4]

MeshKey& HPS::MeshKey::SetVertexRGBAColorsByList	(	SizeTArray const &	in_vertices,
		RGBAColorArray const &	in_rgba_colors,
		Mesh::Component	in_apply_to = Mesh::Component::Faces
	)

Sets vertex RGBA colors on a selection of arbitrary vertices which apply to the specified mesh component.

If the sizes of the vertex index array and color array are different, the smaller size will be used.

Parameters

in_vertices	The indices of the vertices on which to set the colors.
in_rgba_colors	The RGBA colors to set on the vertices.
in_apply_to	The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

SetVertexRGBAColorsByList() [3/4]

MeshKey& HPS::MeshKey::SetVertexRGBAColorsByList	(	size_t	in_count,
		size_t const	in_vertices[],
		RGBAColor const &	in_rgba_color,
		Mesh::Component	in_apply_to = Mesh::Component::Faces
	)

Sets a single RGBA color on a selection of arbitrary vertices which apply to the specified mesh component.

Parameters

in_count	Size of the following array.
in_vertices	The indices of the vertices on which to set the color.
in_rgba_color	The RGBA color to set on the vertices.
in_apply_to	The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

SetVertexRGBAColorsByList() [4/4]

MeshKey& HPS::MeshKey::SetVertexRGBAColorsByList	(	SizeTArray const &	in_vertices,
		RGBAColor const &	in_rgba_color,
		Mesh::Component	in_apply_to = Mesh::Component::Faces
	)

Sets a single RGBA color on a selection of arbitrary vertices which apply to the specified mesh component.

Parameters

in_vertices	The indices of the vertices on which to set the color.
in_rgba_color	The RGBA color to set on the vertices.
in_apply_to	The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

SetVertexRGBAColorsByRange() [1/3]

MeshKey& HPS::MeshKey::SetVertexRGBAColorsByRange	(	size_t	in_start,
		size_t	in_count,
		RGBAColor const	in_rgba_colors[],
		Mesh::Component	in_apply_to = Mesh::Component::Faces
	)

Sets vertex RGBA colors on a range of vertices starting at the specified offset which apply to the specified mesh component.

Parameters

in_start	The offset into the vertices for this MeshKey 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<=vertex_count for the setting to succeed.
in_rgba_colors	The RGBA colors to set on the vertices for this MeshKey.
in_apply_to	The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

SetVertexRGBAColorsByRange() [2/3]

MeshKey& HPS::MeshKey::SetVertexRGBAColorsByRange	(	size_t	in_start,
		RGBAColorArray const &	in_rgba_colors,
		Mesh::Component	in_apply_to = Mesh::Component::Faces
	)

Sets vertex RGBA colors on a range of vertices starting at the specified offset which apply to the specified mesh component.

Parameters

in_start	The offset into the vertices for this MeshKey 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 MeshKey. The size of the array must be such that in_start+in_rgba_colors.size()<=vertex_count for the setting to succeed.
in_apply_to	The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

SetVertexRGBAColorsByRange() [3/3]

MeshKey& HPS::MeshKey::SetVertexRGBAColorsByRange	(	size_t	in_start,
		size_t	in_count,
		RGBAColor const &	in_rgba_color,
		Mesh::Component	in_apply_to = Mesh::Component::Faces
	)

Sets a single RGBA color on a range of vertices starting at the specified offset which apply to the specified mesh component.

Parameters

in_start	The offset into the vertices for this MeshKey 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<=vertex_count for the setting to succeed.
in_rgba_color	The RGBA color to set on the vertices for this MeshKey.
in_apply_to	The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

SetVertexRGBColorsByList() [1/4]

MeshKey& HPS::MeshKey::SetVertexRGBColorsByList	(	size_t	in_count,
		size_t const	in_vertices[],
		RGBColor const	in_rgb_colors[],
		Mesh::Component	in_apply_to = Mesh::Component::Faces
	)

Sets vertex RGB colors on a selection of arbitrary vertices which apply to the specified mesh component.

Parameters

in_count	Size of the following arrays.
in_vertices	The indices of the vertices on which to set the colors.
in_rgb_colors	The RGB colors to set on the vertices.
in_apply_to	The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

SetVertexRGBColorsByList() [2/4]

MeshKey& HPS::MeshKey::SetVertexRGBColorsByList	(	SizeTArray const &	in_vertices,
		RGBColorArray const &	in_rgb_colors,
		Mesh::Component	in_apply_to = Mesh::Component::Faces
	)

Sets vertex RGB colors on a selection of arbitrary vertices which apply to the specified mesh component.

If the sizes of the vertex index array and the color array different, the smaller size will be used.

Parameters

in_vertices	The indices of the vertices on which to set the colors.
in_rgb_colors	The RGB colors to set on the vertices.
in_apply_to	The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

SetVertexRGBColorsByList() [3/4]

MeshKey& HPS::MeshKey::SetVertexRGBColorsByList	(	size_t	in_count,
		size_t const	in_vertices[],
		RGBColor const &	in_rgb_color,
		Mesh::Component	in_apply_to = Mesh::Component::Faces
	)

Sets a single RGB color on a selection of arbitrary vertices which apply to the specified mesh component.

Parameters

in_count	Size of the following array.
in_vertices	The indices of the vertices on which to set the color.
in_rgb_color	The RGB color to set on the vertices.
in_apply_to	The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

SetVertexRGBColorsByList() [4/4]

MeshKey& HPS::MeshKey::SetVertexRGBColorsByList	(	SizeTArray const &	in_vertices,
		RGBColor const &	in_rgb_color,
		Mesh::Component	in_apply_to = Mesh::Component::Faces
	)

Sets a single RGB color on a selection of arbitrary vertices which apply to the specified mesh component.

Parameters

in_vertices	The indices of the vertices on which to set the color.
in_rgb_color	The RGB color to set on the vertices.
in_apply_to	The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

SetVertexRGBColorsByRange() [1/3]

MeshKey& HPS::MeshKey::SetVertexRGBColorsByRange	(	size_t	in_start,
		size_t	in_count,
		RGBColor const	in_rgb_colors[],
		Mesh::Component	in_apply_to = Mesh::Component::Faces
	)

Sets vertex RGB colors on a range of vertices starting at the specified offset which apply to the specified mesh component.

Parameters

in_start	The offset into the vertices for this MeshKey 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<=vertex_count for the setting to succeed.
in_rgb_colors	The RGB colors to set on the vertices for this MeshKey.
in_apply_to	The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

SetVertexRGBColorsByRange() [2/3]

MeshKey& HPS::MeshKey::SetVertexRGBColorsByRange	(	size_t	in_start,
		RGBColorArray const &	in_rgb_colors,
		Mesh::Component	in_apply_to = Mesh::Component::Faces
	)

Sets vertex RGB colors on a range of vertices starting at the specified offset which apply to the specified mesh component.

Parameters

in_start	The offset into the vertices for this MeshKey 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 MeshKey. The size of the array must be such that in_start+in_rgb_colors.size()<=vertex_count for the setting to succeed.
in_apply_to	The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

SetVertexRGBColorsByRange() [3/3]

MeshKey& HPS::MeshKey::SetVertexRGBColorsByRange	(	size_t	in_start,
		size_t	in_count,
		RGBColor const &	in_rgb_color,
		Mesh::Component	in_apply_to = Mesh::Component::Faces
	)

Sets a single RGB color on a range of vertices starting at the specified offset which apply to the specified mesh component.

Parameters

in_start	The offset into the vertices for this MeshKey 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<=vertex_count for the setting to succeed.
in_rgb_color	The RGB color to set on the vertices for this MeshKey.
in_apply_to	The mesh component the colors should apply to. Defaults to Mesh::Component::Faces.

Returns

A reference to this MeshKey.

SetVertexVisibilitiesByList() [1/4]

MeshKey& HPS::MeshKey::SetVertexVisibilitiesByList	(	size_t	in_count,
		size_t const	in_vertices[],
		bool const	in_visibilities[]
	)

Sets vertex visibilities on a selection of arbitrary vertices.

Parameters

in_count	Size of the following arrays.
in_vertices	The indices of the vertices on which to set the visibilities.
in_visibilities	The visibilities to set on the vertices.

Returns

A reference to this MeshKey.

SetVertexVisibilitiesByList() [2/4]

MeshKey& HPS::MeshKey::SetVertexVisibilitiesByList	(	SizeTArray const &	in_vertices,
		BoolArray const &	in_visibilities
	)

Sets vertex visibilities on a selection of arbitrary vertices.

If the sizes of the vertex index and visibility arrays are different, the smaller size will be used.

Parameters

in_vertices	The indices of the vertices on which to set the visibilities.
in_visibilities	The visibilities to set on the vertices.

Returns

A reference to this MeshKey.

SetVertexVisibilitiesByList() [3/4]

MeshKey& HPS::MeshKey::SetVertexVisibilitiesByList	(	size_t	in_count,
		size_t const	in_vertices[],
		bool	in_visibility
	)

Sets a single visibility on a selection of arbitrary vertices.

Parameters

in_count	Size of the following array.
in_vertices	The indices of the vertices on which to set the visibility.
in_visibility	The visibility to set on the vertices.

Returns

A reference to this MeshKey.

SetVertexVisibilitiesByList() [4/4]

MeshKey& HPS::MeshKey::SetVertexVisibilitiesByList	(	SizeTArray const &	in_vertices,
		bool	in_visibility
	)

Sets a single visibility on a selection of arbitrary vertices.

Parameters

in_vertices	The indices of the vertices on which to set the visibility.
in_visibility	The visibility to set on the vertices.

Returns

A reference to this MeshKey.

SetVertexVisibilitiesByRange() [1/3]

MeshKey& HPS::MeshKey::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 MeshKey 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<=vertex_count for the setting to succeed.
in_visibilities	The visibilities to set on the vertices for this MeshKey.

Returns

A reference to this MeshKey.

SetVertexVisibilitiesByRange() [2/3]

MeshKey& HPS::MeshKey::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 MeshKey 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 MeshKey. The size of the array must be such that in_start+in_visibilities.size()<=vertex_count for the setting to succeed.

Returns

A reference to this MeshKey.

SetVertexVisibilitiesByRange() [3/3]

MeshKey& HPS::MeshKey::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 MeshKey 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<=vertex_count for the setting to succeed.
in_visibility	The visibility to set on the vertices for this MeshKey.

Returns

A reference to this MeshKey.

Show()

void HPS::MeshKey::Show

(

MeshKit &

out_kit

)

const

Copy the contents of this MeshKey into the specified kit.

Parameters

out_kit

The kit to populate with the contents of this MeshKey.

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.

ShowColumns()

bool HPS::MeshKey::ShowColumns

(

size_t &

out_columns

)

const

Show the number of columns for this MeshKey.

Parameters

out_columns

The number of columns for this MeshKey.

Returns

true if columns were set, false otherwise.

ShowEdgeColors()

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

ShowEdgeColorsByList()

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

ShowEdgeVisibilitiesByList()

bool HPS::MeshKey::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::MeshKey::ShowFaceColors	(	MaterialTypeArray &	out_types,
		RGBColorArray &	out_rgb_colors,
		FloatArray &	out_indices
	)		const

Shows the face colors on MeshKey.

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::MeshKey::ShowFaceColorsByList	(	SizeTArray const &	in_faces,
		MaterialTypeArray &	out_types,
		RGBColorArray &	out_rgb_colors,
		FloatArray &	out_indices
	)		const

Shows the face colors on a selection of arbitrary faces.

The order of the values in the ouput arrays is the same as the input face index array, i.e., the values of out_types[i], out_rgb_colors[i], and out_indices[i], correspond to the face at index in_faces[i].

Parameters

in_faces	The indices of the faces on which to show the colors.
out_types	The types of face colors for each face at the specified index. If a face at a specified index does not have a face color set, the entry in this array will be Material::Type::None.
out_rgb_colors	The RGB colors for each face at the specified index. out_rgb_colors[i] is only valid if out_types[i] is Material::Type::RGBColor.
out_indices	The material indices for each face at the specified index. The out_indices[i] is only valid if out_types[i] is Material::Type::MaterialIndex.

Returns

true if any specified face had a face color set, false otherwise.

ShowFaceColorsByRange()

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

ShowFaceNormals()

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

Shows all the face normals for this MeshKey.

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::MeshKey::ShowFaceNormalsByList	(	SizeTArray const &	in_faces,
		BoolArray &	out_validities,
		VectorArray &	out_normals
	)		const

Shows the face normals on a selection of arbitrary faces.

The order of the values in the output arrays is the same as the input face index array, i.e., the values of out_validities[i] and out_normals[i] correspond to the face at index in_faces[i].

Parameters

in_faces	The indices of the faces on which to show the normals.
out_validities	The validities of the normals for each face at the specified index. If a face at a specified index had a normal set on it, the entry in this array will be true, otherwise it will be false.
out_normals	The face normals for each face at the specified index. out_normals[i] is only valid if out_validities[i] is true.

Returns

true if any specified face had a face normal set, false otherwise.

ShowFaceNormalsByRange()

bool HPS::MeshKey::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 MeshKey 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.
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::MeshKey::ShowFaceVisibilities	(	BoolArray &	out_validities,
		BoolArray &	out_visibilities
	)		const

Shows all the face visibilities on this MeshKey.

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 or 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::MeshKey::ShowFaceVisibilitiesByList	(	SizeTArray const &	in_faces,
		BoolArray &	out_validities,
		BoolArray &	out_visibilities
	)		const

Shows the face visibilities on a selection of arbitrary faces.

The order of the values in the output arrays is the same as the input face index array, i.e., the values of out_validities[i] and out_visibilities[i] correspond to the face at index in_faces[i].

Parameters

in_faces	The indices of the faces on which to show the normals.
out_validities	The validities of the normals for each face at the specified index. If a face at a specified index had a visibility set on it, the entry in this array will be true, otherwise it will be false.
out_visibilities	The face visibilities for each face at the specified index. out_visibilities[i] is only valid if out_validities[i] is true.

Returns

true if any specified face had a face visibility set, false otherwise.

ShowFaceVisibilitiesByRange()

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

(

MaterialMappingKit &

out_kit

)

const

Shows the material mappings set on this MeshKey.

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

Parameters

out_kit

The material mappings set on this MeshKey.

Returns

true if material mappings were set, false otherwise.

ShowNetVertexNormals()

bool HPS::MeshKey::ShowNetVertexNormals

(

VectorArray &

out_normals

)

const

Shows the all net vertex normals on this MeshKey.

Parameters

out_normals

The vertex normals for each vertex.

Returns

true if no errors were encountered, false otherwise.

ShowNetVertexNormalsByRange()

bool HPS::MeshKey::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 MeshKey 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() [1/2]

bool HPS::MeshKey::ShowPoints

(

PointArray &

out_points

)

const

Show the points for this MeshKey.

Parameters

out_points

The points for this MeshKey.

Returns

true if points were set, false otherwise.

ShowPoints() [2/2]

bool HPS::MeshKey::ShowPoints	(	size_t &	out_rows,
		size_t &	out_columns,
		PointArray &	out_points
	)		const

Show the number of rows, number of columns, and points for this MeshKey.

Parameters

out_rows	The number of rows for this MeshKey.
out_columns	The number of columns for this MeshKey.
out_points	The points for this MeshKey.

Returns

true if points were set, false otherwise.

ShowPointsByList() [1/2]

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

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

Parameters

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

Returns

true if all requested points were set, false otherwise.

ShowPointsByList() [2/2]

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

Show a subset of the points for this MeshKey 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 MeshKey.

Returns

true if all requested points were set, false otherwise.

ShowPointsByRange()

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

Show a subset of the points for this MeshKey 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 MeshKey.

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.

ShowRows()

bool HPS::MeshKey::ShowRows

(

size_t &

out_rows

)

const

Show the number of rows for this MeshKey.

Parameters

out_rows

The number of rows for this MeshKey.

Returns

true if rows were 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::MeshKey::ShowVertexColors	(	Mesh::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 mesh component.

Parameters

in_apply_to	The mesh 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 mesh 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::MeshKey::ShowVertexColorsByList	(	SizeTArray const &	in_vertices,
		Mesh::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 mesh component.

The order of the values in the ouput arrays is the same as the input vertex index array, i.e., the values of out_types[i], out_rgb_colors[i], out_rgba_colors[i], and out_indices[i], correspond to the vertex at index in_vertices[i].

Parameters

in_vertices	The indices of the vertices on which to show the colors.
in_apply_to	The mesh 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::MeshKey::ShowVertexColorsByRange	(	size_t	in_start,
		size_t	in_count,
		Mesh::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 mesh component.

Parameters

in_start	The offset into the vertices for this MeshKey at which to start showing colors. This value must be such that in_start<point_count for removal to succeed.
in_count	The number of colors to show.
in_apply_to	The mesh 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 mesh 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::MeshKey::ShowVertexNormals	(	BoolArray &	out_validities,
		VectorArray &	out_normals
	)		const

Shows all the vertex normals on this MeshKey.

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::MeshKey::ShowVertexNormalsByList	(	SizeTArray const &	in_vertices,
		BoolArray &	out_validities,
		VectorArray &	out_normals
	)		const

Shows the vertex normals on a selection of arbitrary vertices.

The order of the values in the output arrays is the same as the input vertex index array, i.e., the values of out_validities[i] and out_normals[i] correspond to the vertex at index in_vertices[i].

Parameters

in_vertices	The indices of the vertices on which to show the normals.
out_validities	The validities of the normals for each vertex at the specified index. If a vertex at a specified index had a normal set on it, the entry in this array will be true, otherwise it will be false.
out_normals	The vertex normals for each vertex at the specified index. out_normals[i] is only valid if out_validities[i] is true.

Returns

true if any specified vertex had a vertex normal set, false otherwise.

ShowVertexNormalsByRange()

bool HPS::MeshKey::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 MeshKey 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.
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::MeshKey::ShowVertexParameters	(	BoolArray &	out_validities,
		FloatArray &	out_params
	)		const

Shows the texture parameters for all the vertices in this MeshKey.

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::MeshKey::ShowVertexParameters	(	BoolArray &	out_validities,
		FloatArray &	out_params,
		size_t &	out_param_width
	)		const

Shows the texture parameters for all the vertices in this MeshKey.

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::MeshKey::ShowVertexParametersByList	(	SizeTArray const &	in_vertices,
		BoolArray &	out_validities,
		FloatArray &	out_params
	)		const

Shows the texture parameters on a selection of arbitrary vertices.

For this particular show function, the parameter width is returned implicitly and could be determined by out_params.size()/in_vertices.size(). The order of the output arrays is the same as the input vertex index array, i.e., out_validities[i] and (out_params[i],...,out_params[i+param_width-1]) correspond to the vertex at index in_vertices[i].

Parameters

in_vertices	The indices of the vertices on which to show the texture parameters.
out_validities	The validities of the texture parameters for each vertex at the specified index. If a vertex at a specified index had a texture parameter set on it, the entry in this array will be true, otherwise it will be false.
out_params	The texture parameters for each vertex at the specified index. (out_params[i],...,out_params[i+param_width-1]) are only valid if out_validities[i] is true.

Returns

true if any specified vertex had a texture parameter set, false otherwise.

ShowVertexParametersByList() [2/2]

bool HPS::MeshKey::ShowVertexParametersByList	(	SizeTArray const &	in_vertices,
		BoolArray &	out_validities,
		FloatArray &	out_params,
		size_t &	out_param_width
	)		const

Shows the texture parameters on a selection of arbitrary vertices.

The order of the output arrays is the same as the input vertex index array, i.e., out_validities[i] and (out_params[i],...,out_params[i+param_width-1]) correspond to the vertex at index in_vertices[i].

Parameters

in_vertices	The indices of the vertices on which to show the texture parameters.
out_validities	The validities of the texture parameters for each vertex at the specified index. If a vertex at a specified index had a texture parameter set on it, the entry in this array will be true, otherwise it will be false.
out_params	The texture parameters for each vertex at the specified index. (out_params[i],...,out_params[i+param_width-1]) are only valid if out_validities[i] is true.
out_param_width	The number of texture parameters per vertex.

Returns

true if any specified vertex had a texture parameter set, false otherwise.

ShowVertexParametersByRange() [1/2]

bool HPS::MeshKey::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 MeshKey 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.
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::MeshKey::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 MeshKey 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.
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::MeshKey::ShowVertexVisibilities	(	BoolArray &	out_validities,
		BoolArray &	out_visibilities
	)		const

Shows all the vertex visibilities on this MeshKey.

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::MeshKey::ShowVertexVisibilitiesByList	(	SizeTArray const &	in_vertices,
		BoolArray &	out_validities,
		BoolArray &	out_visibilities
	)		const

Shows the vertex visibilities on a selection of arbitrary vertices.

The order of the values in the output arrays is the same as the input vertex index array, i.e., the values of out_validities[i] and out_visibilities[i] correspond to the vertex at index in_vertices[i].

Parameters

in_vertices	The indices of the vertices on which to show the normals.
out_validities	The validities of the normals for each vertex at the specified index. If a vertex at a specified index had a visibility set on it, the entry in this array will be true, otherwise it will be false.
out_visibilities	The vertex visibilities for each vertex at the specified index. out_visibilities[i] is only valid if out_validities[i] is true.

Returns

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

ShowVertexVisibilitiesByRange()

bool HPS::MeshKey::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 MeshKey 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.
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()

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

UnsetEdgeColorsByList() [1/2]

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

UnsetEdgeColorsByList() [2/2]

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

UnsetEdgeEverything()

MeshKey& HPS::MeshKey::UnsetEdgeEverything

(

)

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

Returns

A reference to this MeshKey.

UnsetEdgeVisibilities()

MeshKey& HPS::MeshKey::UnsetEdgeVisibilities

(

)

Removes all vertex visibilities.

Returns

A reference to this MeshKey.

UnsetEdgeVisibilitiesByList() [1/2]

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

UnsetEdgeVisibilitiesByList() [2/2]

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

UnsetEverything()

MeshKey& HPS::MeshKey::UnsetEverything

(

)

Removes all settings from this MeshKey.

Returns

A reference to this MeshKey.

UnsetFaceColors()

MeshKey& HPS::MeshKey::UnsetFaceColors

(

)

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

Returns

A reference to this MeshKey.

UnsetFaceColorsByList() [1/2]

MeshKey& HPS::MeshKey::UnsetFaceColorsByList

(

SizeTArray const &

in_faces

)

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

Parameters

in_faces

The indices of the faces on which to remove the colors.

Returns

A reference to this MeshKey.

UnsetFaceColorsByList() [2/2]

MeshKey& HPS::MeshKey::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 MeshKey.
in_faces	The indices of the faces on which to remove the visibilities.

Returns

A reference to this MeshKey.

UnsetFaceColorsByRange()

MeshKey& HPS::MeshKey::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 MeshKey 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 unset for this MeshKey.

Returns

A reference to this MeshKey.

UnsetFaceEverything()

MeshKey& HPS::MeshKey::UnsetFaceEverything

(

)

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

Returns

A reference to this MeshKey.

UnsetFaceNormals()

MeshKey& HPS::MeshKey::UnsetFaceNormals

(

)

Removes all face normals.

Returns

A reference to this MeshKey.

UnsetFaceNormalsByList()

MeshKey& HPS::MeshKey::UnsetFaceNormalsByList

(

SizeTArray const &

in_faces

)

Removes the face normals on a selection of arbitrary faces.

Parameters

in_faces

The indices of the faces on which to remove the normals.

Returns

A reference to this MeshKey.

UnsetFaceNormalsByRange()

MeshKey& HPS::MeshKey::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 MeshKey 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 unset for this MeshKey.

Returns

A reference to this MeshKey.

UnsetFaceVisibilities()

MeshKey& HPS::MeshKey::UnsetFaceVisibilities

(

)

Removes all face visibilities.

Returns

A reference to this MeshKey.

UnsetFaceVisibilitiesByList() [1/2]

MeshKey& HPS::MeshKey::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 MeshKey.
in_faces	The indices of the faces on which to remove the visibilities.

Returns

A reference to this MeshKey.

UnsetFaceVisibilitiesByList() [2/2]

MeshKey& HPS::MeshKey::UnsetFaceVisibilitiesByList

(

SizeTArray const &

in_faces

)

Removes the face visibilities on a selection of arbitrary faces.

Parameters

in_faces

The indices of the faces on which to remove the visibilities.

Returns

A reference to this MeshKey.

UnsetFaceVisibilitiesByRange()

MeshKey& HPS::MeshKey::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 MeshKey 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 unset for this MeshKey.

Returns

A reference to this MeshKey.

UnsetMaterialMapping()

MeshKey& HPS::MeshKey::UnsetMaterialMapping

(

)

Removes all material mappings on this MeshKey.

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

Returns

A reference to this MeshKey.

UnsetPriority()

GeometryKey& HPS::GeometryKey::UnsetPriority ( )

inherited

Removes the drawing priority setting.

Returns

A reference to this object.

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]

MeshKey& HPS::MeshKey::UnsetVertexColors

(

)

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

Returns

A reference to this MeshKey.

UnsetVertexColors() [2/2]

MeshKey& HPS::MeshKey::UnsetVertexColors

(

Mesh::Component

in_apply_to

)

Removes all vertex colors (RGB colors, RGBA colors, or material indices) for the specified mesh component.

Parameters

in_apply_to

The mesh component for which to remove the colors.

Returns

A reference to this MeshKey.

UnsetVertexColorsByList() [1/4]

MeshKey& HPS::MeshKey::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 MeshKey.
in_faces	The indices of the vertices on which to remove the visibilities.

Returns

A reference to this MeshKey.

UnsetVertexColorsByList() [2/4]

MeshKey& HPS::MeshKey::UnsetVertexColorsByList	(	size_t	in_count,
		size_t const	in_vertices[],
		Mesh::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 MeshKey.
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 MeshKey.

UnsetVertexColorsByList() [3/4]

MeshKey& HPS::MeshKey::UnsetVertexColorsByList

(

SizeTArray const &

in_vertices

)

Removes the vertex colors (RGB colors, RGBA colors, or material indices) for all mesh components on a selection of arbitrary vertices.

Parameters

in_vertices

The indices of the vertices on which to remove the colors.

Returns

A reference to this MeshKey.

UnsetVertexColorsByList() [4/4]

MeshKey& HPS::MeshKey::UnsetVertexColorsByList	(	SizeTArray const &	in_vertices,
		Mesh::Component	in_apply_to
	)

Removes the vertex colors (RGB colors, RGBA colors, or material indices) for the specificed mesh component on a selection of arbitrary vertices.

Parameters

in_vertices	The indices of the vertices on which to remove the colors.
in_apply_to	The mesh component for which to remove the colors.

Returns

A reference to this MeshKey.

UnsetVertexColorsByRange() [1/2]

MeshKey& HPS::MeshKey::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 mesh components starting at the specified offset.

Parameters

in_start	The offset into the vertices for this MeshKey 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 unset for this MeshKey.

Returns

A reference to this MeshKey.

UnsetVertexColorsByRange() [2/2]

MeshKey& HPS::MeshKey::UnsetVertexColorsByRange	(	size_t	in_start,
		size_t	in_count,
		Mesh::Component	in_apply_to
	)

Removes the specified range of vertex colors (RGB colors, RGBA colors, or material indices) for the specified mesh component starting at the specified offset.

Parameters

in_start	The offset into the vertices for this MeshKey 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 unset for this MeshKey.
in_apply_to	The mesh component for which to remove the colors.

Returns

A reference to this MeshKey.

UnsetVertexEverything()

MeshKey& HPS::MeshKey::UnsetVertexEverything

(

)

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

Returns

A reference to this MeshKey.

UnsetVertexNormals()

MeshKey& HPS::MeshKey::UnsetVertexNormals

(

)

Removes all vertex normals.

Returns

A reference to this MeshKey.

UnsetVertexNormalsByList()

MeshKey& HPS::MeshKey::UnsetVertexNormalsByList

(

SizeTArray const &

in_vertices

)

Removes the vertex normals on a selection of arbitrary vertices.

Parameters

in_vertices

The indices of the vertices on which to remove the normals.

Returns

A reference to this MeshKey.

UnsetVertexNormalsByRange()

MeshKey& HPS::MeshKey::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 MeshKey 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 unset for this MeshKey.

Returns

A reference to this MeshKey.

UnsetVertexParameters()

MeshKey& HPS::MeshKey::UnsetVertexParameters

(

)

Removes all texture parameters.

Returns

A reference to this MeshKey.

UnsetVertexParametersByList()

MeshKey& HPS::MeshKey::UnsetVertexParametersByList

(

SizeTArray const &

in_vertices

)

Removes the texture parameters on a selection of arbitrary vertices.

Parameters

in_vertices

The indices of the vertices on which to remove the texture parameters.

Returns

A reference to this MeshKey.

UnsetVertexParametersByRange()

MeshKey& HPS::MeshKey::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 MeshKey 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 unset for this MeshKey.

Returns

A reference to this MeshKey.

UnsetVertexVisibilities()

MeshKey& HPS::MeshKey::UnsetVertexVisibilities

(

)

Removes all vertex visibilities.

Returns

A reference to this MeshKey.

UnsetVertexVisibilitiesByList() [1/2]

MeshKey& HPS::MeshKey::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 MeshKey.
in_faces	The indices of the vertices on which to remove the visibilities.

Returns

A reference to this MeshKey.

UnsetVertexVisibilitiesByList() [2/2]

MeshKey& HPS::MeshKey::UnsetVertexVisibilitiesByList

(

SizeTArray const &

in_vertices

)

Removes the vertex visibilities on a selection of arbitrary vertices.

Parameters

in_vertices

The indices of the vertices on which to remove the visibilities.

Returns

A reference to this MeshKey.

UnsetVertexVisibilitiesByRange()

MeshKey& HPS::MeshKey::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 MeshKey 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 unset for this MeshKey.

Returns

A reference to this MeshKey.

Up()

SegmentKey HPS::Key::Up ( ) const

inherited

Returns

The segment containing this key.

Member Data Documentation

staticType

const HPS::Type HPS::MeshKey::staticType = HPS::Type::MeshKey

static

---

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

• hps.h