EXPERIMENTAL

class EXPERIMENTAL

class CellularVolumeKey : public HPS::GeometryKey 

The CellularVolumeKey class is a smart pointer to a database object. It is a handle to a cellular colume created by SegmentKey::InsertCellularVolume. *

Warning

This functionality is experimental and may change in future versions. To find out more, please follow the release page.

Public Functions

CellularVolumeKey(): The default constructor creates an uninitialized CellularVolumeKey object. The Type() function will return Type::None.

CellularVolumeKey(CellularVolumeKey &&in_that)

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

Parameters:	in_that – An rvalue reference to a CellularVolumeKey to take the impl from.

CellularVolumeKey(CellularVolumeKey const &in_that)

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

Parameters:	in_that – The source CellularVolumeKey to copy.

explicit CellularVolumeKey(Key const &in_that)

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

Parameters:	in_key – The source Key to copy.

void Consume(CellularVolumeKit &in_kit)

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

CellularVolumeKey &EditCellsByDeletion(HPS::IntArray const &in_cells_list)

Removes points from the point list for this CellularVolumeKey. This will not affect the points referenced by the removed cells.

Parameters:	in_cells_list – The cells to remove from the volume.
Returns:	A reference to this CellularVolumeKey.

CellularVolumeKey &EditCellsByDeletion(size_t in_count, int const in_cells_list[])

Removes cells from the cell list for this CellularVolumeKey. This will not affect the points referenced by the removed cells.

Parameters:	in_count – The number of cells to delete from the cell list for the volume. in_cells_list – The cells to remove from the volume.
Returns:	A reference to this CellularVolumeKey.

CellularVolumeKey &EditCellsByDeletion(size_t in_offset, size_t in_count)

Removes cells from the cell list for this CellularVolumeKey. This will not affect the points referenced by the removed cells.

Parameters:

in_offset – The offset into the cells for the volume at which to start removing cells. This value must be such that in_offset<cell_count for deletion to succeed. This is not an offset into the raw cell list, but is relative to the actual cell count for the volume.
in_count – The number of cells to remove from the cell list for the volume. This value must be such that in_offset+in_count<=cell_count for the deletion to succeed.

Returns:

A reference to this CellularVolumeKey.

CellularVolumeKey &EditCellsListByInsertion(size_t in_offset, HPS::IntArray const &in_cells_list)

Adds cells to the cell list for this CellularVolumeKey.

Parameters:	in_offset – The offset into the faces for the volume at which to insert faces. This value must be such that in_offset <= cell_count for insertion to succeed. This is not an offset into the raw cell list, but is relative to the actual cell count for the volume. in_cells_list – The cells to insert into the cell list at the specified offset.
Returns:	A reference to this CellularVolumeKey.

CellularVolumeKey &EditCellsListByInsertion(size_t in_offset, size_t in_count, int const in_cells_list[])

Adds cells to the cell list for this CellularVolumeKey.

Parameters:

in_offset – The offset into the cells for the volume at which to insert faces. This value must be such that in_offset <= cell_count for insertion to succeed. This is not an offset into the raw cell list, but is relative to the actual cell count for the volume.
in_count – Size of the following array.
in_cells_list – The cells to insert into the cell list at the specified offset.

Returns:

A reference to this CellularVolumeKey.

CellularVolumeKey &EditCellsListByReplacement(size_t in_offset, HPS::IntArray const &in_cells_list)

Replaces cellss in the cell list for this CellularVolumeKey.

Parameters:

in_offset – The offset into the cells for the volume at which to start replacing cells. This value must be such that in_offset<cell_count for replacement to succeed. This is not an offset into the raw cell list, but is relative to the actual cell count for the volume.
in_cells_list – The cells to use to replace those in the cell list at the specified offset. The number of replacement cells must be such that in_offset+replacement_cell_count<=cell_count. This does not mean that the cell list length must be the same, i.e., cells can be of different types than previously, but rather is a limit on the number of cells encoded in the face list.

Returns:

A reference to this CellularVolumeKey.

CellularVolumeKey &EditCellsListByReplacement(size_t in_offset, size_t in_count, int const in_cells_list[])

Replaces cells in the cell list for this CellularVolumeKey.

Parameters:

in_offset – The offset into the cells for the volume at which to start replacing cells. This value must be such that in_offset<cell_count for replacement to succeed. This is not an offset into the raw cell list, but is relative to the actual cell count for the volume.
in_count – Size of the following array.
in_cells_list – The cells to use to replace those in the cell list at the specified offset. The number of replacement cells must be such that in_offset+replacement_cell_count<=cell_count. This does not mean that the cell list length must be the same, i.e., cells can be of different types than previously, but rather is a limit on the number of cells encoded in the cell list.

Returns:

A reference to this CellularVolumeKey.

CellularVolumeKey &EditPointsByDeletion(HPS::IntArray const &in_points_list)

Removes points from the point list for this CellularVolumeKey. Any existing cells which reference points which are being deleted will be removed. Additionally, any vertex settings on the deleted vertices, i.e., colors & parameters, will be removed. The cell list will also be updated to reflect the new vertex offsets caused by removing elements from the point list.

Parameters:	in_points_list – The points to remove from the volume.
Returns:	A reference to this CellularVolumeKey.

CellularVolumeKey &EditPointsByDeletion(size_t in_count, int const in_points_list[])

Removes points from the point list for this CellularVolumeKey. Any existing cells which reference points which are being deleted will be removed. Additionally, any vertex settings on the deleted vertices, i.e., colors and parameters, will be removed. The cell list will also be updated to reflect the new vertex offsets caused by removing elements from the point list.

Parameters:	in_count – The number of points to delete from the point list for the volume. in_points_list – The points to remove from the volume.
Returns:	A reference to this CellularVolumeKey.

CellularVolumeKey &EditPointsByDeletion(size_t in_offset, size_t in_count)

Removes points from the point list for this CellularVolumeKey. Any existing cells which reference points which are being deleted will be removed. Additionally, any vertex settings on the deleted vertices, i.e., colorsand parameters, will be removed. The cell list will also be updated to reflect the new vertex offsets caused by removing elements from the point list.

Parameters:	in_offset – The offset into the point list for the volume at which to start removing points. This value must be such that in_offset<point_count for deletion to succeed. in_count – The number of points to delete from the point list for the volume. This value must be such that in_offset+in_count<=point_count for the deletion to succeed.
Returns:	A reference to this CellularVolumeKey.

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

Adds points to the point list for this CellularVolumeKey. No existing cells will reference these points, i.e., the cell list will be updated to reference the original vertices in their new positions. Addtionally, no vertex attributes will apply to these points, i.e., the vertex attributes will only be set on those points which had them prior to the insertion.

Parameters:	in_offset – The offset into the point list for the volume at which to insert points. This value must be such that in_offset <= point_count for insertion to succeed. in_points – The points to insert into the point list at the specified offset.
Returns:	A reference to this CellularVolumeKey.

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

Adds points to the point list for this CellularVolumeKey. No existing cells will reference these points, i.e., the cell list will be updated to reference the original vertices in their new positions. Addtionally, no vertex attributes will apply to these points, i.e., the vertex attributes will only be set on those points which had them prior to the insertion.

Parameters:	in_offset – The offset into the point list for the volume at which to insert points. This value must be such that in_offset <= point_count for insertion to succeed. in_count – Size of the following array. in_points – The points to insert into the point list at the specified offset.
Returns:	A reference to this CellularVolumeKey.

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

Replaces points in the point list for this CellularVolumeKey. These points will replace those already referenced by any cells and will inherit any attributes the points being replaced had.

Parameters:	in_offset – The offset into the point list for the volume at which to start replacing points. This value must be such that in_offset<point_count for replacement to succeed. in_points – The points to use to replace those in the point list at the specified offset. This size of the array must be such that in_offset+in_points.size()<=point_count for the replacement to succeed.
Returns:	A reference to this CellularVolumeKey.

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

Replaces points in the point list for this CellularVolumeKey. These points will replace those already referenced by any cells and will inherit any attributes the points being replaced had.

Parameters:

in_offset – The offset into the point list for the volume at which to start replacing points. This value must be such that in_offset<point_count for replacement to succeed.
in_count – Size of the following array. This value must be such that in_offset+in_count<=point_count for the replacement to succeed.
in_points – The points to use to replace those in the point list at the specified offset.

Returns:

A reference to this CellularVolumeKey.

size_t GetCellCount() const

Retrieves the number of cells in this volume. Note that this is different than the length of the cell list

Returns:	The number of cells in this volume.

size_t GetFaceCount() const

Retrieves the number of faces in this volume. Note that this is different than the length of the cell list or number of cells, and is not trivially determined by examining the list. Informational only.

Returns:	The number of faces in this volume.

size_t GetPointCount() const

Retrieves the number of points in this volume.

Returns:	The number of points in this volume.

inline virtual HPS::Type ObjectType() const

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns:	The declared type of the object in question, which may differ from the true, underlying type.

CellularVolumeKey &operator=(CellularVolumeKey &&in_that)

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

Parameters:	in_that – An rvalue reference to a CellularVolumeKey to take the impl from.
Returns:	A reference to this CellularVolumeKey.

CellularVolumeKey &operator=(CellularVolumeKey const &other)

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

Parameters:	in_that – The source CellularVolumeKey for the assignment.
Returns:	A reference to this CellularVolumeKey.

void Set(CellularVolumeKit const &in_kit)

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

Parameters:	in_kit – The kit from which to get the settings to replace on this CellularVolumeKey.

CellularVolumeKey &SetCellsList(HPS::IntArray const &in_cells_list)

Replace the cell list on this CellularVolumeKey with the specified cell list.

Parameters:	in_cells_list – The face list to use to replace the one for this CellularVolumeKey.
Returns:	A reference to this CellularVolumeKey.

CellularVolumeKey &SetCellsList(size_t in_count, int const in_cells_list[])

Replace the cell list on this CellularVolumeKey with the specified cell list.

Parameters:	in_count – Size of the following array. in_cells_list – The cakk list to use to replace the one for this CellularVolumeKey.
Returns:	A reference to this CellularVolumeKey.

CellularVolumeKey &SetMaterialMapping(HPS::MaterialMappingKit const &in_kit)

Sets the specified material mappings on this CellularVolumeKey. Only face, back face, cut edge, cut face, edge, and vertex materials will be set on the volume. These material settings will be “global” for the volume, 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 CellularVolumeKey.
Returns:	A reference to this CellularVolumeKey.

CellularVolumeKey &SetPoints(HPS::PointArray const &in_points)

Replace the points on this CellularVolumeKey with the specified points.

Parameters:	in_points – The points to use to replace those for this CellularVolumeKey.
Returns:	A reference to this CellularVolumeKey.

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

Replace the points on this CellularVolumeKey with the specified points.

Parameters:	in_count – Size of the following array. in_points – The points to use to replace those for this CellularVolumeKey.
Returns:	A reference to this CellularVolumeKey.

CellularVolumeKey &SetVertexIndexColorsByList(HPS::SizeTArray const &in_vertices, float in_index, HPS::CellularVolume::Component in_apply_to = HPS::CellularVolume::Component::Faces)

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

Parameters:	in_vertices – The indices of the vertices on which to set the color. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_index – The material index to set on the vertices. in_apply_to – The volume component the colors should apply to. Defaults to CellularVolume::Component::Faces.
Returns:	A reference to this CellularVolumeKey.

CellularVolumeKey &SetVertexIndexColorsByList(HPS::SizeTArray const &in_vertices, HPS::FloatArray const &in_indices, HPS::CellularVolume::Component in_apply_to = HPS::CellularVolume::Component::Faces)

Sets vertex material indices on a selection of arbitrary vertices which apply to the specified volume component. If the sizes of the vertex index and material index arrays are different, the smaller size will be used.

Parameters:	in_vertices – The indices of the vertices on which to set the colors. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_indices – The material indices to set on the vertices. in_apply_to – The volume component the colors should apply to. Defaults to CellularVolume::Component::Faces.
Returns:	A reference to this CellularVolumeKey.

CellularVolumeKey &SetVertexIndexColorsByList(size_t in_count, size_t const in_vertices[], float const in_indices[], HPS::CellularVolume::Component in_apply_to = HPS::CellularVolume::Component::Faces)

Sets vertex material indices on a selection of arbitrary vertices which apply to the specified volume 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 volume component the colors should apply to. Defaults to CellularVolume::Component::Faces.
Returns:	A reference to this CellularVolumeKey.

CellularVolumeKey &SetVertexIndexColorsByList(size_t in_count, size_t const in_vertices[], float in_index, HPS::CellularVolume::Component in_apply_to = HPS::CellularVolume::Component::Faces)

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

Parameters:	in_count – Size of the following array. in_vertices – The indices of the vertices on which to set the color. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_index – The material index to set on the vertices. in_apply_to – The volume component the colors should apply to. Defaults to CellularVolume::Component::Faces.
Returns:	A reference to this CellularVolumeKey.

CellularVolumeKey &SetVertexIndexColorsByRange(size_t in_start, HPS::FloatArray const &in_indices, HPS::CellularVolume::Component in_apply_to = HPS::CellularVolume::Component::Faces)

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

Parameters:

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

Returns:

A reference to this CellularVolumeKey.

CellularVolumeKey &SetVertexIndexColorsByRange(size_t in_start, size_t in_count, float const in_indices[], HPS::CellularVolume::Component in_apply_to = HPS::CellularVolume::Component::Faces)

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

Parameters:

in_start – The offset into the vertices for this CellularVolumeKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed.
in_count – Size of the following array. This value must be such that in_start+in_count<=point_count for the setting to succeed.
in_indices – The material indices to set on the vertices for this CellularVolumeKey.
in_apply_to – The volume component the colors should apply to. Defaults to HPS::CellularVolume::Component::Faces.

Returns:

A reference to this CellularVolumeKey.

CellularVolumeKey &SetVertexIndexColorsByRange(size_t in_start, size_t in_count, float in_index, HPS::CellularVolume::Component in_apply_to = HPS::CellularVolume::Component::Faces)

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

Parameters:

in_start – The offset into the vertices for this CellularVolumeKey at which to start setting the color. This value must be such that in_start<point_count for setting to succeed.
in_count – The number of vertices on which to set the color. This value must be such that in_start+in_count<=point_count for the setting to succeed.
in_index – The material index to set on the vertices for this CellularVolumeKey.
in_apply_to – The volume component the colors should apply to. Defaults to CellularVolume::Component::Faces.

Returns:

A reference to this CellularVolumeKey.

CellularVolumeKey &SetVertexParametersByList(HPS::SizeTArray const &in_vertices, HPS::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 parameter array (divided by the parameter width) are different, the smaller size will be used.

Parameters:

in_vertices – The indices of the vertices on which to set the texture parameters. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_params – The texture parameters to set on the vertices for this CellularVolumeKey. 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 CellularVolumeKey.

CellularVolumeKey &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 parameter array (divided by the parameter width) are different, the smaller size will be used.

Parameters:

in_vertex_count – Size of the following array.
in_vertices – The indices of the vertices on which to set the texture parameters. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed.
in_param_count – Size of the following array. This should be divisible by the parameter width, if it is not, some parameters will get ignored.
in_params – The texture parameters to set on the vertices for this CellularVolumeKey.
in_param_width – The number of texture parameters per vertex. Defaults to 2.

Returns:

A reference to this CellularVolumeKey.

CellularVolumeKey &SetVertexParametersByRange(size_t in_start, HPS::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 CellularVolumeKey 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 CellularVolumeKey. The size of the array should be divisible by the parameter width, if it is not, some parameters will get ignored. The size of the array must be such that in_start+in_params.size()/in_param_width<=point_count for the setting to succeed.
in_param_width – The number of texture parameters per vertex. Defaults to 2.

Returns:

A reference to this CellularVolumeKey.

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

Returns:

A reference to this CellularVolumeKey.

CellularVolumeKey &SetVertexRGBColorsByList(HPS::SizeTArray const &in_vertices, HPS::RGBColor const &in_rgb_color, HPS::CellularVolume::Component in_apply_to = HPS::CellularVolume::Component::Faces)

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

Parameters:	in_vertices – The indices of the vertices on which to set the color. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_rgb_color – The RGB color to set on the vertices. in_apply_to – The volume component the colors should apply to. Defaults to CellularVolume::Component::Faces.
Returns:	A reference to this CellularVolumeKey.

CellularVolumeKey &SetVertexRGBColorsByList(HPS::SizeTArray const &in_vertices, HPS::RGBColorArray const &in_rgb_colors, HPS::CellularVolume::Component in_apply_to = HPS::CellularVolume::Component::Faces)

Sets vertex RGB colors on a selection of arbitrary vertices which apply to the specified volume component. If the sizes of the vertex index array and the color array different, the smaller size will be used.

Parameters:	in_vertices – The indices of the vertices on which to set the colors. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_rgb_colors – The RGB colors to set on the vertices. in_apply_to – The volume component the colors should apply to. Defaults to CellularVolume::Component::Faces.
Returns:	A reference to this CellularVolumeKey.

CellularVolumeKey &SetVertexRGBColorsByList(size_t in_count, size_t const in_vertices[], HPS::RGBColor const &in_rgb_color, HPS::CellularVolume::Component in_apply_to = HPS::CellularVolume::Component::Faces)

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

Parameters:	in_count – Size of the following array. in_vertices – The indices of the vertices on which to set the color. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_rgb_color – The RGB color to set on the vertices. in_apply_to – The volume component the colors should apply to. Defaults to CellularVolume::Component::Faces.
Returns:	A reference to this CellularVolumeKey.

CellularVolumeKey &SetVertexRGBColorsByList(size_t in_count, size_t const in_vertices[], HPS::RGBColor const in_rgb_colors[], HPS::CellularVolume::Component in_apply_to = HPS::CellularVolume::Component::Faces)

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

Parameters:	in_count – Size of the following arrays. in_vertices – The indices of the vertices on which to set the colors. Each index in the array must be such that in_vertices[i]<point_count for setting to succeed. in_rgb_colors – The RGB colors to set on the vertices. in_apply_to – The volume component the colors should apply to. Defaults to HPS::CellularVolume::Component::Faces.
Returns:	A reference to this CellularVolumeKey.

CellularVolumeKey &SetVertexRGBColorsByRange(size_t in_start, HPS::RGBColorArray const &in_rgb_colors, HPS::CellularVolume::Component in_apply_to = HPS::CellularVolume::Component::Faces)

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

Parameters:

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

Returns:

A reference to this CellularVolumeKey.

CellularVolumeKey &SetVertexRGBColorsByRange(size_t in_start, size_t in_count, HPS::RGBColor const &in_rgb_color, HPS::CellularVolume::Component in_apply_to = HPS::CellularVolume::Component::Faces)

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

Parameters:

in_start – The offset into the vertices for this CellularVolumeKey at which to start setting the color. This value must be such that in_start<point_count for setting to succeed.
in_count – The number of vertices on which to set the color. This value must be such that in_start+in_count<=point_count for the setting to succeed.
in_rgb_color – The RGB color to set on the vertices for this CellularVolumeKey.
in_apply_to – The volume component the colors should apply to. Defaults to CellularVolume::Component::Faces.

Returns:

A reference to this CellularVolumeKey.

CellularVolumeKey &SetVertexRGBColorsByRange(size_t in_start, size_t in_count, HPS::RGBColor const in_rgb_colors[], HPS::CellularVolume::Component in_apply_to = HPS::CellularVolume::Component::Faces)

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

Parameters:

in_start – The offset into the vertices for this CellularVolumeKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed.
in_count – Size of the following array. This value must be such that in_start+in_count<=point_count for the setting to succeed.
in_rgb_colors – The RGB colors to set on the vertices for this CellularVolumeKey.
in_apply_to – The volume component the colors should apply to. Defaults to CellularVolume::Component::Faces.

Returns:

A reference to this CellularVolumeKey.

void Show(CellularVolumeKit &out_kit) const

Copy the contents of this CellularVolumeKey into the specified kit.

Parameters:	out_kit – The kit to populate with the contents of this CellularVolumeKey.

bool ShowCellsList(HPS::IntArray &out_cells_list) const

Show the cell list for this CellularVolumeKey.

Parameters:	out_cells_list – The cell list for this CellularVolumeKey.
Returns:	true if cell list was set, false otherwise.

bool ShowMaterialMapping(HPS::MaterialMappingKit &out_kit) const

Shows the material mappings set on this CellularVolumeKey. These are the “global” material settings, not the per-vertex and per-face material settings.

Parameters:	out_kit – The material mappings set on this CellularVolumeKey.
Returns:	true if material mappings were set, false otherwise.

bool ShowPoints(HPS::PointArray &out_points) const

Show the points for this CellularVolumeKey.

Parameters:	out_points – The points for this CellularVolumeKey.
Returns:	true if points were set, false otherwise.

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

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

Parameters:	in_indices – The list of point indices to show. out_points – The requested points for this CellularVolumeKey.
Returns:	true if all requested points were set, false otherwise.

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

Show a subset of the points for this CellularVolumeKey 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 CellularVolumeKey.
Returns:	true if all requested points were set, false otherwise.

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

Show a subset of the points for this CellularVolumeKey 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 CellularVolumeKey.
Returns:	true if all requested points were set, false otherwise.

bool ShowVertexColors(HPS::CellularVolume::Component in_apply_to, HPS::MaterialTypeArray &out_types, HPS::RGBColorArray &out_rgb_colors, HPS::FloatArray &out_indices) const

Shows all the vertex colors on the specified volume component.

Parameters:

in_apply_to – The volume 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 volume component, the entry in this array will be Material::Type::None.
out_rgb_colors – The RGB colors for each vertex. out_rgb_colors[i] is only valid if out_types[i] is Material::Type::RGBColor.
out_indices – The material indices for each vertex. The out_indices[i] is only valid if out_types[i] is Material::Type::MaterialIndex.

Returns:

true if any vertex colors were shown, false otherwise.

bool ShowVertexColorsByList(HPS::SizeTArray const &in_vertices, HPS::CellularVolume::Component in_apply_to, HPS::MaterialTypeArray &out_types, HPS::RGBColorArray &out_rgb_colors, HPS::FloatArray &out_indices) const

Shows the vertex colors on a selection of arbitrary vertices which apply to the specified volume component. The order of the values in the ouput arrays is the same as the input vertex index array, i.e., the values of out_types[i], out_rgb_colors[i], out_rgba_colors[i], and out_indices[i], correspond to the vertex at index in_vertices[i].

Parameters:

in_vertices – The indices of the vertices on which to show the colors. Each index in the array must be such that in_vertices[i]<point_count for showing to succeed.
in_apply_to – The volume component the colors should apply to.
out_types – The types of vertex colors for each vertex at the specified index. If a vertex at a specified index does not have a vertex color set for the specified component, the entry in this array will be Material::Type::None.
out_rgb_colors – The RGB colors for each vertex at the specified index. out_rgb_colors[i] is only valid if out_types[i] is Material::Type::RGBColor.
out_indices – The material indices for each vertex at the specified index. The out_indices[i] is only valid if out_types[i] is Material::Type::MaterialIndex.

Returns:

true if any specified vertex had a vertex color on the specified component set, false otherwise.

bool ShowVertexColorsByRange(size_t in_start, size_t in_count, HPS::CellularVolume::Component in_apply_to, HPS::MaterialTypeArray &out_types, HPS::RGBColorArray &out_rgb_colors, HPS::FloatArray &out_indices) const

Shows the vertex colors on a range of vertices starting at the specified offset which apply to the specified volume component.

Parameters:

in_start – The offset into the vertices for this CellularVolumeKey at which to start showing colors. This value must be such that in_start<point_count for showing to succeed.
in_count – The number of colors to show. This value must be such that in_start+in_count<=point_count for the showing to succeed.
in_apply_to – The volume 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 volume component, the entry in this array will be Material::Type::None.
out_rgb_colors – The RGB colors for each vertex in the specified range. out_rgb_colors[i] is only valid if out_types[i] is Material::Type::RGBColor.
out_indices – The material indices for each vertex in the specified range. The out_indices[i] is only valid if out_types[i] is Material::Type::MaterialIndex.

Returns:

true if any vertex in the specified range had a vertex color on the specified component set, false otherwise.

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

Shows the texture parameters for all of the vertices on this CellularVolumeKey. For this particular show function, the parameter width is returned implicitly and could be determined by out_params.size()/in_count.

Parameters:	out_validities – The validities of the texture parameters for each vertex. If a vertex had a texture parameter set on it, the entry in this array will be true, otherwise it will be false. out_params – The texture parameters for each vertex. (out_params[i],…,out_params[i+param_width-1]) are only valid if out_validities[i] is true.
Returns:	true if any vertex had a texture parameter set, false otherwise.

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

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

Parameters:

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

Returns:

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

bool ShowVertexParametersByList(HPS::SizeTArray const &in_vertices, HPS::BoolArray &out_validities, HPS::FloatArray &out_params) const

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

Parameters:

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

Returns:

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

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

Shows the texture parameters on a selection of arbitrary vertices. The order of the output arrays is the same as the input vertex index array, i.e., out_validities[i] and (out_params[i],…,out_params[i+param_width-1]) correspond to the vertex at index in_vertices[i].

Parameters:

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

Returns:

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

bool ShowVertexParametersByRange(size_t in_start, size_t in_count, HPS::BoolArray &out_validities, HPS::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 CellularVolumeKey at which to start showing texture parameters. This value must be such that in_start<point_count for showing to succeed.
in_count – The number of vertices for which to show the texture parameters. This value must be such that in_start+in_count<=point_count for the showing to succeed.
out_validities – The validities of the texture parameters for each vertex in the specified range. If a vertex in the specified range had a texture parameter set on it, the entry in this array will be true, otherwise it will be false.
out_params – The texture parameters for each vertex in the specified range. (out_params[i],…,out_params[i+param_width-1]) are only valid if out_validities[i] is true.

Returns:

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

bool ShowVertexParametersByRange(size_t in_start, size_t in_count, HPS::BoolArray &out_validities, HPS::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 CellularVolumeKey at which to start showing texture parameters. This value must be such that in_start<point_count for showing to succeed.
in_count – The number of vertices for which to show the texture parameters. This value must be such that in_start+in_count<=point_count for the showing to succeed.
out_validities – The validities of the texture parameters for each vertex in the specified range. If a vertex in the specified range had a texture parameter set on it, the entry in this array will be true, otherwise it will be false.
out_params – The texture parameters for each vertex in the specified range. (out_params[i],…,out_params[i+param_width-1]) are only valid if out_validities[i] is true.
out_param_width – The number of texture parameters per vertex.

Returns:

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

CellularVolumeKey &UnsetCellsList()

Removes the cell list for this CellularVolumeKey.

Returns:	A reference to this CellularVolumeKey.

CellularVolumeKey &UnsetEverything()

Removes all settings from this CellularVolumeKey.

Returns:	A reference to this CellularVolumeKey.

CellularVolumeKey &UnsetMaterialMapping()

Removes all material mappings on this CellularVolumeKey. This removes the “global” material settings and does not affect per-vertex or per-face materials.

Returns:	A reference to this CellularVolumeKey.

CellularVolumeKey &UnsetPoints()

Removes the points for this CellularVolumeKey.

Returns:	A reference to this CellularVolumeKey.

CellularVolumeKey &UnsetVertexColors()

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

Returns:	A reference to this CellularVolumeKey.

CellularVolumeKey &UnsetVertexColors(HPS::CellularVolume::Component in_apply_to)

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

Parameters:	in_apply_to – The volume component for which to remove the colors.
Returns:	A reference to this CellularVolumeKey.

CellularVolumeKey &UnsetVertexColorsByList(HPS::SizeTArray const &in_vertices)

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

Parameters:	in_vertices – The indices of the vertices on which to remove the colors. Each index in the array must be such that in_vertices[i]<point_count for removal to succeed.
Returns:	A reference to this CellularVolumeKey.

CellularVolumeKey &UnsetVertexColorsByList(HPS::SizeTArray const &in_vertices, HPS::CellularVolume::Component in_apply_to)

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

Parameters:	in_vertices – The indices of the vertices on which to remove the colors. Each index in the array must be such that in_vertices[i]<point_count for removal to succeed. in_apply_to – The volume component for which to remove the colors.
Returns:	A reference to this CellularVolumeKey.

CellularVolumeKey &UnsetVertexColorsByList(size_t in_count, size_t const in_vertices[])

Removes the vertex colors on a selection of arbitrary vertices.

Parameters:	in_count – The number of vertex visibilities to remove for this CellularVolumeKey. in_vertices – The indices of the vertices on which to remove the visibilities.
Returns:	A reference to this CellularVolumeKey.

CellularVolumeKey &UnsetVertexColorsByList(size_t in_count, size_t const in_vertices[], HPS::CellularVolume::Component in_apply_to)

Removes the vertex colors on a selection of arbitrary vertices.

Parameters:	in_count – The number of vertex visibilities to remove for this CellularVolumeKey. in_vertices – The indices of the vertices on which to remove the visibilities. in_apply_to – The volume component the colors should apply to.
Returns:	A reference to this CellularVolumeKey.

CellularVolumeKey &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 volume components starting at the specified offset.

Parameters:	in_start – The offset into the vertices for this CellularVolumeKey at which to start removing colors. This value must be such that in_start<point_count for removal to succeed. in_count – The number of vertex colors to remove for this CellularVolumeKey. This value must be such that in_start+in_count<=point_count for the removal to succeed.
Returns:	A reference to this CellularVolumeKey.

CellularVolumeKey &UnsetVertexColorsByRange(size_t in_start, size_t in_count, HPS::CellularVolume::Component in_apply_to)

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

Parameters:

in_start – The offset into the vertices for this CellularVolumeKey at which to start removing colors. This value must be such that in_start<point_count for removal to succeed.
in_count – The number of vertex colors to remove for this CellularVolumeKey. This value must be such that in_start+in_count<=point_count for the removal to succeed.
in_apply_to – The volume component for which to remove the colors.

Returns:

A reference to this CellularVolumeKey.

CellularVolumeKey &UnsetVertexEverything()

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

Returns:	A reference to this CellularVolumeKey.

CellularVolumeKey &UnsetVertexParameters()

Removes all texture parameters.

Returns:	A reference to this CellularVolumeKey.

CellularVolumeKey &UnsetVertexParametersByList(HPS::SizeTArray const &in_vertices)

Removes the texture parameters on a selection of arbitrary vertices.

Parameters:	in_vertices – The indices of the vertices on which to remove the texture parameters. Each index in the array must be such that in_vertices[i]<point_count for removal to succeed.
Returns:	A reference to this CellularVolumeKey.

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

~CellularVolumeKey()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::CellularVolumeKey

class CellularVolumeKit : public HPS::Kit 

The CellularVolumeKit class is a user space object. It is the kit analog to a CellularVolumeKey.

Warning

This functionality is experimental and may change in future versions. To find out more, please follow the release page.

Public Functions

CellularVolumeKit(): The default constructor creates an empty CellularVolumeKit object.

CellularVolumeKit(CellularVolumeKit &&in_that)

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

Parameters:	in_that – An rvalue reference to a CellularVolumeKit to take the impl from.

CellularVolumeKit(CellularVolumeKit const &in_kit)

The copy constructor creates a new CellularVolumeKit object that contains the same settings as the source CellularVolumeKit.

Parameters:	in_kit – The source CellularVolumeKit to copy.

void Consume(CellularVolumeKit &in_kit)

Copies the source CellularVolumeKit into this CellularVolumeKit and resets the source kit.

Parameters:	in_kit – The source CellularVolumeKit to consume.

CellularVolumeKit &EditCellsByDeletion(size_t in_offset, size_t in_count)

Removes cells from the cell list for this CellularVolumeKit. This will not affect the points referenced by the removed cells, however any cell attributes on the removed cells will be lost.

Parameters:

in_offset – The offset into the cells for the volume at which to start removing cells. This value must be such that in_offset<cell_count for deletion to succeed. This is not an offset into the raw cell list, but is relative to the actual cell count for the volume.
in_count – The number of cells to remove from the cell list for the volume. This value must be such that in_offset+in_count<=cell_count for the deletion to succeed.

Returns:

A reference to this CellularVolumeKit.

CellularVolumeKit &EditCellsListByInsertion(size_t in_offset, IntArray const &in_cellslist)

Adds cells to the cell list for this CellularVolumeKit.

Parameters:	in_offset – The offset into the cells for the volume at which to insert cells. This value must be such that in_offset <= cell_count for insertion to succeed. This is not an offset into the raw cell list, but is relative to the actual cell count for the volume. in_cellslist – The cells (using the standard cell-list encoding) to insert into the cell list at the specified offset.
Returns:	A reference to this CellularVolumeKit.

CellularVolumeKit &EditCellsListByInsertion(size_t in_offset, size_t in_count, int const in_cellslist[])

Adds cells to the cell list for this CellularVolumeKit.

Parameters:

in_offset – The offset into the cells for the volume at which to insert cells. This value must be such that in_offset <= cell_count for insertion to succeed. This is not an offset into the raw cell list, but is relative to the actual cell count for the volume.
in_count – Size of the following array.
in_cellslist – The cells (using the standard cell-list encoding) to insert into the cells list at the specified offset.

Returns:

A reference to this CellularVolumeKit.

CellularVolumeKit &EditCellsListByReplacement(size_t in_offset, IntArray const &in_cellslist)

Replaces cells in the cell list for this CellularVolumeKit.

Parameters:

in_offset – The offset into the cells for the volume at which to start replacing cells. This value must be such that in_offset<cell_count for replacement to succeed. This is not an offset into the raw cell list, but is relative to the actual cell count for the volume.
in_cellslist – The cells (using the standard cell-list encoding) to use to replace those in the cell list at the specified offset. The number of replacement cells must be such that in_offset+replacement_cell_count<=cell_count. This does not mean that the cell list length must be the same, i.e., cells can use different numbers of vertices than previously, but rather is a limit on the number of cells encoded in the cell list.

Returns:

A reference to this CellularVolumeKit.

CellularVolumeKit &EditCellsListByReplacement(size_t in_offset, size_t in_count, int const in_cellslist[])

Replaces cells in the cell list for this CellularVolumeKit.

Parameters:

in_offset – The offset into the cells for the volume at which to start replacing cells. This value must be such that in_offset<cell_count for replacement to succeed. This is not an offset into the raw cell list, but is relative to the actual cell count for the volume.
in_count – Size of the following array.
in_cellslist – The cells (using the standard cell-list encoding) to use to replace those in the cell list at the specified offset. The number of replacement cells must be such that in_offset+replacement_cell_count<=cell_count. This does not mean that the cell list length must be the same, i.e., cells can use different numbers of vertices than previously, but rather is a limit on the number of cells encoded in the cell list.

Returns:

A reference to this CellularVolumeKit.

CellularVolumeKit &EditPointsByDeletion(size_t in_offset, size_t in_count)

Removes points from the point list for this CellularVolumeKit. Any existing cells which reference points which are being deleted will be removed. Additionally, any vertex attributes on the deleted vertices, i.e., colors & parameters, will be removed. The cells list will also be updated to reflect the new vertex offsets caused by removing elements from the point list.

Parameters:	in_offset – The offset into the point list for the volume at which to start removing points. This value must be such that in_offset<point_count for deletion to succeed. in_count – The number of points to delete from the point list for the volume. This value must be such that in_offset+in_count<=point_count for the deletion to succeed.
Returns:	A reference to this CellularVolumeKit.

CellularVolumeKit &EditPointsByInsertion(size_t in_offset, PointArray const &in_points)

Adds points to the point list for this CellularVolumeKit. No existing cells will reference these points, i.e., the cells list will be updated to reference the original vertices in their new positions. Addtionally, no vertex attributes will apply to these points, i.e., the vertex attributes will only be set on those points which had them prior to the insertion.

Parameters:	in_offset – The offset into the point list for the volume at which to insert points. This value must be such that in_offset <= point_count for insertion to succeed. in_points – The points to insert into the point list at the specified offset.
Returns:	A reference to this CellularVolumeKit.

CellularVolumeKit &EditPointsByInsertion(size_t in_offset, size_t in_count, Point const in_points[])

Adds points to the point list for this CellularVolumeKit. No existing cells will reference these points, i.e., the cells list will be updated to reference the original vertices in their new positions. Addtionally, no vertex attributes will apply to these points, i.e., the vertex attributes will only be set on those points which had them prior to the insertion.

Parameters:	in_offset – The offset into the point list for the volume at which to insert points. This value must be such that in_offset <= point_count for insertion to succeed. in_count – Size of the following array. in_points – The points to insert into the point list at the specified offset.
Returns:	A reference to this CellularVolumeKit.

CellularVolumeKit &EditPointsByReplacement(size_t in_offset, PointArray const &in_points)

Replaces points in the point list for this CellularVolumeKit. These points will replace those already referenced by any cells and will inherit any attributes the points being replaced had.

Parameters:	in_offset – The offset into the point list for the volume at which to start replacing points. This value must be such that in_offset<point_count for replacement to succeed. in_points – The points to use to replace those in the point list at the specified offset. This size of the array must be such that in_offset+in_points.size()<=point_count for the replacement to succeed.
Returns:	A reference to this CellularVolumeKit.

CellularVolumeKit &EditPointsByReplacement(size_t in_offset, size_t in_count, Point const in_points[])

Replaces points in the point list for this CellularVolumeKit. These points will replace those already referenced by any cells and will inherit any attributes the points being replaced had.

Parameters:

in_offset – The offset into the point list for the volume at which to start replacing points. This value must be such that in_offset<point_count for replacement to succeed.
in_count – Size of the following array. This value must be such that in_offset+in_count<=point_count for the replacement to succeed.
in_points – The points to use to replace those in the point list at the specified offset.

Returns:

A reference to this CellularVolumeKit.

virtual bool Empty() const

Indicates whether this CellularVolumeKit has any values set on it.

Returns:	true if no values are set on this CellularVolumeKit, false otherwise.

bool Equals(CellularVolumeKit const &in_kit) const

Check if the source CellularVolumeKit is equivalent to this CellularVolumeKit.

Parameters:	in_kit – The source CellularVolumeKit to compare to this CellularVolumeKit.
Returns:	true if the objects are equivalent, false otherwise.

size_t GetCellCount() const

Retrieves the number of cells in this volume. Note that this is different than the length of the cells list

Returns:	The number of cells in this volume.

size_t GetPointCount() const

Retrieves the number of points in this cellular volume.

Returns:	The number of points in this cellular volume.

inline virtual HPS::Type ObjectType() const

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns:	The declared type of the object in question, which may differ from the true, underlying type.

bool operator!=(CellularVolumeKit const &in_kit) const

Check if the source CellularVolumeKit is not equivalent to this CellularVolumeKit.

Parameters:	in_kit – The source CellularVolumeKit to compare to this CellularVolumeKit.
Returns:	true if the objects are not equivalent, false otherwise.

CellularVolumeKit &operator=(CellularVolumeKit &&in_that)

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

Parameters:	in_that – An rvalue reference to a CellularVolumeKit to take the impl from.
Returns:	A reference to this CellularVolumeKit.

CellularVolumeKit &operator=(CellularVolumeKit const &in_kit)

Copies the source CellularVolumeKit into this CellularVolumeKit.

Parameters:	in_kit – The source CellularVolumeKit to copy.
Returns:	A reference to this CellularVolumeKit.

bool operator==(CellularVolumeKit const &in_kit) const

Check if the source CellularVolumeKit is equivalent to this CellularVolumeKit.

Parameters:	in_kit – The source CellularVolumeKit to compare to this CellularVolumeKit.
Returns:	true if the objects are equivalent, false otherwise.

void Set(CellularVolumeKit const &in_kit)

Copies the source CellularVolumeKit into this CellularVolumeKit.

Parameters:	in_kit – The source CellularVolumeKit to copy.

CellularVolumeKit &SetCellsList(HPS::IntArray const &in_cells_list)

Sets the cell list for this CellularVolumeKit.

Parameters:	in_cells_list – The cell list for this CellularVolumeKit.
Returns:	A reference to this CellularVolumeKit.

CellularVolumeKit &SetCellsList(size_t in_count, int const in_cells_list[])

Sets the cell list for this CellularVolumeKit.

Parameters:	in_count – Size of the following array. in_cells_list – The cell list for this CellularVolumeKit.
Returns:	A reference to this CellularVolumeKit.

CellularVolumeKit &SetMaterialMapping(HPS::MaterialMappingKit const &in_kit)

Sets the specified material mappings on this CellularVolumeKit. If this kit is used to insert a colume, only face, back face, cut edge, cut face, edge, and vertex materials will be set on the inserted volume. These material settings will be “global” for the volume, 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 CellularVolumeKit.
Returns:	A reference to this CellularVolumeKit.

CellularVolumeKit &SetPoints(HPS::PointArray const &in_points)

Sets the points for this CellularVolumeKit.

Parameters:	in_points – The points for this CellularVolumeKit.
Returns:	A reference to this CellularVolumeKit.

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

Sets the points for this CellularVolumeKit.

Parameters:	in_count – Size of the following array. in_points – The points for this CellularVolumeKit.
Returns:	A reference to this CellularVolumeKit.

CellularVolumeKit &SetPriority(int in_priority)

Assigns a specific drawing priority value to the CellularVolumeKit. It affects the order in which the contents of this segment are drawn if and only if the rendering algorithm is set to Priority.

See also

SubwindowKit::SetRenderingAlgorithm()

Parameters:	in_priority – The drawing priority, higher priority items are drawn on top of lower priority items.
Returns:	A reference to this object.

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

Sets user data on this kit.

Parameters:	in_indices – An array of user data indices to set. in_data – An array of bytes of user data to set.
Returns:	A reference to this kit.

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

Sets user data on this kit.

Parameters:	in_index – The index of the user data to set. in_data – The bytes of user data to set.
Returns:	A reference to this kit.

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

Sets user data on this kit.

Parameters:	in_index – The index of the user data to set. in_bytes – The number of bytes of user data to set. in_data – The bytes of user data to set.
Returns:	A reference to this kit.

CellularVolumeKit &SetVertexIndexColorsByList(HPS::SizeTArray const &in_vertices, float in_index, HPS::CellularVolume::Component in_apply_to = HPS::CellularVolume::Component::Faces)

Sets a single material index on a selection of arbitrary vertices which apply to the specified volume 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 volume component the colors should apply to. Defaults to HPS::CellularVolume::Component::Faces.
Returns:	A reference to this CellularVolumeKit.

CellularVolumeKit &SetVertexIndexColorsByList(HPS::SizeTArray const &in_vertices, HPS::FloatArray const &in_indices, HPS::CellularVolume::Component in_apply_to = HPS::CellularVolume::Component::Faces)

Sets vertex material indices on a selection of arbitrary vertices which apply to the specified volume 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 volume component the colors should apply to. Defaults to HPS::CellularVolume::Component::Faces.
Returns:	A reference to this CellularVolumeKit.

CellularVolumeKit &SetVertexIndexColorsByList(size_t in_count, size_t const in_vertices[], float const in_indices[], HPS::CellularVolume::Component in_apply_to = HPS::CellularVolume::Component::Faces)

Sets vertex material indices on a selection of arbitrary vertices which apply to the specified volume 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 volume component the colors should apply to. Defaults to HPS::CellularVolume::Component::Faces.
Returns:	A reference to this CellularVolumeKit.

CellularVolumeKit &SetVertexIndexColorsByList(size_t in_count, size_t const in_vertices[], float in_index, HPS::CellularVolume::Component in_apply_to = HPS::CellularVolume::Component::Faces)

Sets a single material index on a selection of arbitrary vertices which apply to the specified volume 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 volume component the colors should apply to. Defaults to HPS::CellularVolume::Component::Faces.
Returns:	A reference to this CellularVolumeKit.

CellularVolumeKit &SetVertexIndexColorsByRange(size_t in_start, HPS::FloatArray const &in_indices, HPS::CellularVolume::Component in_apply_to = HPS::CellularVolume::Component::Faces)

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

Parameters:	in_start – The offset into the vertices for this CellularVolumeKit at which to start setting colors. in_indices – The material indices to set on the vertices for this CellularVolumeKit. in_apply_to – The volume component the colors should apply to. Defaults to CellularVolume::Component::Faces.
Returns:	A reference to this CellularVolumeKit.

CellularVolumeKit &SetVertexIndexColorsByRange(size_t in_start, size_t in_count, float const in_indices[], HPS::CellularVolume::Component in_apply_to = HPS::CellularVolume::Component::Faces)

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

Parameters:	in_start – The offset into the vertices for this CellularVolumeKit at which to start setting colors. in_count – Size of the following array. in_indices – The material indices to set on the vertices for this CellularVolumeKit. in_apply_to – The volume component the colors should apply to. Defaults to CellularVolume::Component::Faces.
Returns:	A reference to this CellularVolumeKit.

CellularVolumeKit &SetVertexIndexColorsByRange(size_t in_start, size_t in_count, float in_index, HPS::CellularVolume::Component in_apply_to = HPS::CellularVolume::Component::Faces)

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

Parameters:	in_start – The offset into the vertices for this CellularVolumeKit at which to start setting the color. in_count – The number of vertices on which to set the color. in_index – The material index to set on the vertices for this CellularVolumeKit. in_apply_to – The volume component the colors should apply to. Defaults to CellularVolume::Component::Faces.
Returns:	A reference to this CellularVolumeKit.

CellularVolumeKit &SetVertexParametersByList(HPS::SizeTArray const &in_vertices, HPS::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 parameter 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 CellularVolumeKit. 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 CellularVolumeKit.

CellularVolumeKit &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 parameter 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 CellularVolumeKit.
in_param_width – The number of texture parameters per vertex. Defaults to 2.

Returns:

A reference to this CellularVolumeKit.

CellularVolumeKit &SetVertexParametersByRange(size_t in_start, HPS::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 CellularVolumeKit at which to start setting texture parameters.
in_params – The texture parameters to set on the vertices for this CellularVolumeKit. 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 CellularVolumeKit.

CellularVolumeKit &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 CellularVolumeKit at which to start setting texture parameters.
in_param_count – Size of the following array. This should be divisible by the parameter width, if it is not, some parameters will get ignored.
in_params – The texture parameters to set on the vertices for this CellularVolumeKit.
in_param_width – The number of texture parameters per vertex. Defaults to 2.

Returns:

A reference to this CellularVolumeKit.

CellularVolumeKit &SetVertexRGBColorsByList(HPS::SizeTArray const &in_vertices, HPS::RGBColor const &in_rgb_color, HPS::CellularVolume::Component in_apply_to = HPS::CellularVolume::Component::Faces)

Sets a single RGB color on a selection of arbitrary vertices which apply to the specified volume 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 volume component the colors should apply to. Defaults to CellularVolume::Component::Faces.
Returns:	A reference to this CellularVolumeKit.

CellularVolumeKit &SetVertexRGBColorsByList(HPS::SizeTArray const &in_vertices, HPS::RGBColorArray const &in_rgb_colors, HPS::CellularVolume::Component in_apply_to = HPS::CellularVolume::Component::Faces)

Sets vertex RGB colors on a selection of arbitrary vertices which apply to the specified volume 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 volume component the colors should apply to. Defaults to CellularVolume::Component::Faces.
Returns:	A reference to this CellularVolumeKit.

CellularVolumeKit &SetVertexRGBColorsByList(size_t in_count, size_t const in_vertices[], HPS::RGBColor const &in_rgb_color, HPS::CellularVolume::Component in_apply_to = HPS::CellularVolume::Component::Faces)

Sets a single RGB color on a selection of arbitrary vertices which apply to the specified volume 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 volume component the colors should apply to. Defaults to CellularVolume::Component::Faces.
Returns:	A reference to this CellularVolumeKit.

CellularVolumeKit &SetVertexRGBColorsByList(size_t in_count, size_t const in_vertices[], HPS::RGBColor const in_rgb_colors[], HPS::CellularVolume::Component in_apply_to = HPS::CellularVolume::Component::Faces)

Sets vertex RGB colors on a selection of arbitrary vertices which apply to the specified volume 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 volume component the colors should apply to. Defaults to CellularVolume::Component::Faces.
Returns:	A reference to this CellularVolumeKit.

CellularVolumeKit &SetVertexRGBColorsByRange(size_t in_start, HPS::RGBColorArray const &in_rgb_colors, HPS::CellularVolume::Component in_apply_to = HPS::CellularVolume::Component::Faces)

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

Parameters:	in_start – The offset into the vertices for this CellularVolumeKit at which to start setting colors. in_rgb_colors – The RGB colors to set on the vertices for this CellularVolumeKit. in_apply_to – The volume component the colors should apply to. Defaults to CellularVolume::Component::Faces.
Returns:	A reference to this CellularVolumeKit.

CellularVolumeKit &SetVertexRGBColorsByRange(size_t in_start, size_t in_count, HPS::RGBColor const &in_rgb_color, HPS::CellularVolume::Component in_apply_to = HPS::CellularVolume::Component::Faces)

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

Parameters:	in_start – The offset into the vertices for this CellularVolumeKit at which to start setting the color. in_count – The number of vertices on which to set the color. in_rgb_color – The RGB color to set on the vertices for this CellularVolumeKit. in_apply_to – The volume component the colors should apply to. Defaults to CellularVolume::Component::Faces.
Returns:	A reference to this CellularVolumeKit.

CellularVolumeKit &SetVertexRGBColorsByRange(size_t in_start, size_t in_count, HPS::RGBColor const in_rgb_colors[], HPS::CellularVolume::Component in_apply_to = HPS::CellularVolume::Component::Faces)

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

Parameters:	in_start – The offset into the vertices for this CellularVolumeKit at which to start setting colors. in_count – Size of the following array. in_rgb_colors – The RGB colors to set on the vertices for this CellularVolumeKit. in_apply_to – The volume component the colors should apply to. Defaults to CellularVolume::Component::Faces.
Returns:	A reference to this CellularVolumeKit.

void Show(CellularVolumeKit &out_kit) const

Copies this CellularVolumeKit into the given CellularVolumeKit.

Parameters:	out_kit – The CellularVolumeKit to populate with the contents of this CellularVolumeKit.

bool ShowCellsList(HPS::IntArray &out_cells_list) const

Show the cell list for this CellularVolumeKit.

Parameters:	out_cells_list – The cell list for this CellularVolumeKit.
Returns:	true if cell list was set, false otherwise.

bool ShowMaterialMapping(HPS::MaterialMappingKit &out_kit) const

Shows the material mappings set on this CellularVolumeKit. These are the “global” material settings, not the per-vertex and per-face material settings.

Parameters:	out_kit – The material mappings set on this CellularVolumeKit.
Returns:	true if material mappings were set, false otherwise.

bool ShowPoints(HPS::PointArray &out_points) const

Show the points for this CellularVolumeKit.

Parameters:	out_points – The points for this CellularVolumeKit.
Returns:	true if points were set, false otherwise.

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

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

Parameters:	in_indices – The list of point indices to show. out_points – The requested points for this CellularVolumeKit.
Returns:	true if all requested points were set, false otherwise.

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

Show a subset of the points for this CellularVolumeKit 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 CellularVolumeKit.
Returns:	true if all requested points were set, false otherwise.

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

Show a subset of the points for this CellularVolumeKit 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 CellularVolumeKit.
Returns:	true if all requested points were set, false otherwise.

bool ShowPriority(int &out_priority) const

Shows the drawing priority.

Parameters:	out_priority – The drawing priority, higher priority items are drawn on top of lower priority items.
Returns:	true if the setting is valid, false otherwise.

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

Shows all user data for this kit.

Parameters:	out_indices – An array of all user data indices set on this kit. out_data – An array of all user data set on this kit.
Returns:	true if there is user data on this kit, false otherwise.

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

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

Parameters:	in_index – The index of the user data to show. out_data – The user data at the given index.
Returns:	true if there is user data at the given index, false otherwise.

size_t ShowUserDataCount() const: Get the number of user data indices set on this kit.

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

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

Parameters:	out_indices – The user data indices set on this kit.
Returns:	The number of user data indices set on this kit.

bool ShowVertexColors(HPS::CellularVolume::Component in_apply_to, HPS::MaterialTypeArray &out_types, HPS::RGBColorArray &out_rgb_colors, HPS::FloatArray &out_indices) const

Shows all the vertex colors on the specified volume component.

Parameters:

in_apply_to – The volume 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 volume component, the entry in this array will be Material::Type::None.
out_rgb_colors – The RGB colors for each vertex. out_rgb_colors[i] is only valid if out_types[i] is Material::Type::RGBColor.
out_indices – The material indices for each vertex. The out_indices[i] is only valid if out_types[i] is Material::Type::MaterialIndex.

Returns:

true if any vertex colors were shown, false otherwise.

bool ShowVertexColorsByList(HPS::SizeTArray const &in_vertices, HPS::CellularVolume::Component in_apply_to, HPS::MaterialTypeArray &out_types, HPS::RGBColorArray &out_rgb_colors, HPS::FloatArray &out_indices) const

Shows the vertex colors on a selection of arbitrary vertices which apply to the specified volume 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 volume component the colors should apply to.
out_types – The types of vertex colors for each vertex at the specified index. If a vertex at a specified index does not have a vertex color set for the specified component, the entry in this array will be Material::Type::None.
out_rgb_colors – The RGB colors for each vertex at the specified index. out_rgb_colors[i] is only valid if out_types[i] is Material::Type::RGBColor.
out_indices – The material indices for each vertex at the specified index. The out_indices[i] is only valid if out_types[i] is Material::Type::MaterialIndex.

Returns:

true if any specified vertex had a vertex color on the specified component set, false otherwise.

bool ShowVertexColorsByRange(size_t in_start, size_t in_count, HPS::CellularVolume::Component in_apply_to, HPS::MaterialTypeArray &out_types, HPS::RGBColorArray &out_rgb_colors, HPS::FloatArray &out_indices) const

Shows the vertex colors on a range of vertices starting at the specified offset which apply to the specified volume component.

Parameters:

in_start – The offset into the vertices for this CellularVolumeKit at which to start showing colors.
in_count – The number of colors to show.
in_apply_to – The volume 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 volume component, the entry in this array will be Material::Type::None.
out_rgb_colors – The RGB colors for each vertex in the specified range. out_rgb_colors[i] is only valid if out_types[i] is Material::Type::RGBColor.
out_indices – The material indices for each vertex in the specified range. The out_indices[i] is only valid if out_types[i] is Material::Type::MaterialIndex.

Returns:

true if any vertex in the specified range had a vertex color on the specified component set, false otherwise.

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

Shows the texture parameters on all of the vertices in this CellularVolumeKit. For this particular show function, the parameter width is returned implicitly and could be determined by out_params.size()/in_count.

Parameters:	out_validities – The validities of the texture parameters for each vertex. If a vertex had a texture parameter set on it, the entry in this array will be true, otherwise it will be false. out_params – The texture parameters for each vertex. (out_params[i],…,out_params[i+param_width-1]) are only valid if out_validities[i] is true.
Returns:	true if any vertex had a texture parameter set, false otherwise.

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

Shows the texture parameters on all of the vertices in this CellularVolumeKit.

Parameters:

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

Returns:

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

bool ShowVertexParametersByList(HPS::SizeTArray const &in_vertices, HPS::BoolArray &out_validities, HPS::FloatArray &out_params) const

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

Parameters:

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

Returns:

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

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

Shows the texture parameters on a selection of arbitrary vertices. The order of the output arrays is the same as the input vertex index array, i.e., out_validities[i] and (out_params[i],…,out_params[i+param_width-1]) correspond to the vertex at index in_vertices[i].

Parameters:

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

Returns:

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

bool ShowVertexParametersByRange(size_t in_start, size_t in_count, HPS::BoolArray &out_validities, HPS::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 CellularVolumeKit at which to start showing texture parameters.
in_count – The number of vertices for which to show the texture parameters.
out_validities – The validities of the texture parameters for each vertex in the specified range. If a vertex in the specified range had a texture parameter set on it, the entry in this array will be true, otherwise it will be false.
out_params – The texture parameters for each vertex in the specified range. (out_params[i],…,out_params[i+param_width-1]) are only valid if out_validities[i] is true.

Returns:

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

bool ShowVertexParametersByRange(size_t in_start, size_t in_count, HPS::BoolArray &out_validities, HPS::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 CellularVolumeKit at which to start showing texture parameters.
in_count – The number of vertices for which to show the texture parameters.
out_validities – The validities of the texture parameters for each vertex in the specified range. If a vertex in the specified range had a texture parameter set on it, the entry in this array will be true, otherwise it will be false.
out_params – The texture parameters for each vertex in the specified range. (out_params[i],…,out_params[i+param_width-1]) are only valid if out_validities[i] is true.
out_param_width – The number of texture parameters per vertex.

Returns:

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

CellularVolumeKit &UnsetAllUserData()

Removes all user data from this kit.

Returns:	A reference to this kit.

CellularVolumeKit &UnsetCellsList()

Removes the cell list for this CellularVolumeKit.

Returns:	A reference to this CellularVolumeKit.

CellularVolumeKit &UnsetEverything()

Removes all settings from this CellularVolumeKit.

Returns:	A reference to this CellularVolumeKit.

CellularVolumeKit &UnsetMaterialMapping()

Removes all material mappings on this CellularVolumeKit. This removes the “global” material settings and does not affect per-vertex or per-face materials.

Returns:	A reference to this CellularVolumeKit.

CellularVolumeKit &UnsetPoints()

Removes the points for this CellularVolumeKit.

Returns:	A reference to this CellularVolumeKit.

CellularVolumeKit &UnsetPriority()

Removes a drawing priority setting.

Returns:	A reference to this object.

CellularVolumeKit &UnsetUserData(HPS::IntPtrTArray const &in_indices)

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

Parameters:	in_indices – The indices of the user data to remove.
Returns:	A reference to this kit.

CellularVolumeKit &UnsetUserData(intptr_t in_index)

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

Parameters:	in_index – The index of the user data to remove.
Returns:	A reference to this kit.

CellularVolumeKit &UnsetUserData(size_t in_count, intptr_t const in_indices[])

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

Parameters:	in_count – The size of the following array. in_indices – The indices of the user data to remove.
Returns:	A reference to this kit.

CellularVolumeKit &UnsetVertexColors()

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

Returns:	A reference to this CellularVolumeKit.

CellularVolumeKit &UnsetVertexColors(HPS::CellularVolume::Component in_apply_to)

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

Parameters:	in_apply_to – The volume component for which to remove the colors.
Returns:	A reference to this CellularVolumeKit.

CellularVolumeKit &UnsetVertexColorsByList(HPS::SizeTArray const &in_vertices)

Removes the vertex colors (RGB colors, RGBA colors, or material indices) for all volume 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 CellularVolumeKit.

CellularVolumeKit &UnsetVertexColorsByList(HPS::SizeTArray const &in_vertices, HPS::CellularVolume::Component in_apply_to)

Removes the vertex colors (RGB colors, RGBA colors, or material indices) for the specified volume 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 volume component for which to remove the colors.
Returns:	A reference to this CellularVolumeKit.

CellularVolumeKit &UnsetVertexColorsByList(size_t in_count, size_t const in_vertices[])

Removes the vertex colors on a selection of arbitrary vertices.

Parameters:	in_count – The number of vertex visibilities to remove for this CellularVolumeKit. in_vertices – The indices of the vertices on which to remove the visibilities.
Returns:	A reference to this CellularVolumeKit.

CellularVolumeKit &UnsetVertexColorsByList(size_t in_count, size_t const in_vertices[], HPS::CellularVolume::Component in_apply_to)

Removes the vertex colors on a selection of arbitrary vertices.

Parameters:	in_count – The number of vertex visibilities to remove for this CellularVolumeKit. in_vertices – The indices of the vertices on which to remove the visibilities. in_apply_to – The volume component the colors should apply to. Defaults to HPS::CellularVolume::Component::Faces.
Returns:	A reference to this CellularVolumeKit.

CellularVolumeKit &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 volume components starting at the specified offset.

Parameters:	in_start – The offset into the vertices for this CellularVolumeKit at which to start removing colors. in_count – The number of vertex colors to remove for this CellularVolumeKit.
Returns:	A reference to this CellularVolumeKit.

CellularVolumeKit &UnsetVertexColorsByRange(size_t in_start, size_t in_count, HPS::CellularVolume::Component in_apply_to)

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

Parameters:	in_start – The offset into the vertices for this CellularVolumeKit at which to start removing colors. in_count – The number of vertex colors to remove for this CellularVolumeKit. in_apply_to – The volume component for which to remove the colors.
Returns:	A reference to this CellularVolumeKit.

CellularVolumeKit &UnsetVertexEverything()

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

Returns:	A reference to this CellularVolumeKit.

CellularVolumeKit &UnsetVertexParameters()

Removes all texture parameters.

Returns:	A reference to this CellularVolumeKit.

CellularVolumeKit &UnsetVertexParametersByList(HPS::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 CellularVolumeKit.

CellularVolumeKit &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 CellularVolumeKit at which to start removing texture parameters. in_count – The number of texture parameters to remove for this CellularVolumeKit.
Returns:	A reference to this CellularVolumeKit.

virtual ~CellularVolumeKit()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::CellularVolumeKit

EXPERIMENTAL

Hello! I'm HOOPSY