EXPERIMENTAL

class HPS.EXPERIMENTAL : IDisposable

Public Functions

void Dispose ()

EXPERIMENTAL (HPS.EXPERIMENTAL in_that)

class CellElement : public HPS.Object

The CellElement class is a user space object. It is the base class for other cell element types. Cell elements are used to define the structure of a cellular volume.

Public Functions

CellElement ()

The default constructor creates an empty CellElement object.

CellElement (HPS.EXPERIMENTAL.CellElement in_that)

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

Param in_that:The source CellElement to copy.

override void Dispose ()

bool Equals (HPS.EXPERIMENTAL.CellElement in_that)

Check if the source CellElement is equivalent to this CellElement.

Param in_that:The source CellElement to compare to this CellElement. Return:true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

override HPS.Type ObjectType ()

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

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

void Set (HPS.EXPERIMENTAL.CellElement in_that)

Copies the source CellElement into this CellElement.

Param in_that:The source CellElement to copy.

HPS.CellularVolume.CellType ShowCellKind ()

Shows the cell kind (Simplex, Pyramid, etc.) of this CellElement.

Return:The CellType describing what kind of cell this element represents.

ulong ShowCellSize ()

Shows the size of each cell in this CellElement.

Return:The number of vertices in each cell of this CellElement.

int[] ShowIndices ()

Shows the indices associated with this CellElement.

Return:The indices describing one or more cells defined by this CellElement.

Public Static Functions

HPS.EXPERIMENTAL.CellElement Box (int p1, int p2, int p3, int p4, int p5, int p6, int p7, int p8)

Creates a box cell element from a set of individual index values.

Return:A CellElement representing a single box cell.

HPS.EXPERIMENTAL.CellElement Box (int[] in_indices)

Creates a box cell element from an array of vertex index values.

Param in_indices:  The array of indices defining one or more box cells; the length must be a multiple of 8. Return:A CellElement representing one or more box cells.

HPS.EXPERIMENTAL.CellElement Face (int[] in_indices)

Creates a face cell element from an array of vertex index values.

Param in_indices:  The array of vertex indices defining a face. Return:A CellElement representing a face definition.

bool operator!= (HPS.EXPERIMENTAL.CellElement a, HPS.EXPERIMENTAL.CellElement b)

bool operator== (HPS.EXPERIMENTAL.CellElement a, HPS.EXPERIMENTAL.CellElement b)

HPS.EXPERIMENTAL.CellElement Polyhedron (int[] in_indices)

Creates a polyhedron cell element from an array of face reference indices.

Param in_indices:  The array of face indices defining a polyhedron. Return:A CellElement representing a polyhedron definition.

HPS.EXPERIMENTAL.CellElement Pyramid (int p1, int p2, int p3, int p4, int p5)

Creates a pyramid cell element from a set of individual index values.

Return:A CellElement representing a single pyramid cell.

HPS.EXPERIMENTAL.CellElement Pyramid (int[] in_indices)

Creates a pyramid cell element from an array of vertex index values.

Param in_indices:  The array of indices defining one or more pyramid cells; the length must be a multiple of 5. Return:A CellElement representing one or more pyramid cells.

HPS.EXPERIMENTAL.CellElement Simplex (int p1, int p2, int p3, int p4)

Creates a simplex cell element from a set of individual index values.

Return:A CellElement representing a single simplex cell.

HPS.EXPERIMENTAL.CellElement Simplex (int[] in_indices)

Creates a simplex cell element from an array of vertex index values.

Param in_indices:  The array of indices defining one or more simplex cells; the length must be a multiple of 4. Return:A CellElement representing one or more simplex cells.

HPS.EXPERIMENTAL.CellElement Wedge (int p1, int p2, int p3, int p4, int p5, int p6)

Creates a wedge cell element from a set of individual index values.

Return:A CellElement representing a single wedge cell.

HPS.EXPERIMENTAL.CellElement Wedge (int[] in_indices)

Creates a wedge cell element from an array of vertex index values.

Param in_indices:  The array of indices defining one or more wedge cells; the length must be a multiple of 6. Return:A CellElement representing one or more wedge cells.

class CellularVolumeKey : public HPS.GeometryKey

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

.

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

Warning

Public Functions

CellularVolumeKey ()

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

CellularVolumeKey (HPS.EXPERIMENTAL.CellularVolumeKey in_that)

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

Param in_that:The source CellularVolumeKey to copy.

CellularVolumeKey (HPS.Key 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.

void Consume (HPS.EXPERIMENTAL.CellularVolumeKit in_kit)

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

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

override void Dispose ()

HPS.EXPERIMENTAL.CellularVolumeKey EditCellsByDeletion (int[] in_specific_cells)

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

Param in_specific_cells:  The cells to remove from the volume. Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey EditCellsByDeletion (ulong in_offset, ulong in_count)

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

Param 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. Param 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. Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey EditCellsByInsertion (ulong in_offset, HPS.EXPERIMENTAL.CellElement[] in_cell_array)

Adds cells to the cell list for this CellularVolumeKey.

Param 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. Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey EditCellsByReplacement (ulong in_offset, HPS.EXPERIMENTAL.CellElement[] in_cell_array)

Replaces cellss in the cell list for this CellularVolumeKey.

Param 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. Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey EditPointsByDeletion (int[] 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.

Param in_points_list:  The points to remove from the volume. Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey EditPointsByDeletion (ulong in_offset, ulong 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., 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.

Param 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. Param 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. Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey EditPointsByInsertion (ulong in_offset, HPS.Point[] 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.

Param 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. Param in_points:  The points to insert into the point list at the specified offset. Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey EditPointsByReplacement (ulong in_offset, HPS.Point[] 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.

Param 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. Param 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. Return:A reference to this CellularVolumeKey.

ulong GetCellCount ()

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

Return:The number of cells in this volume.

ulong GetFaceCount ()

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.

Return:The number of faces in this volume.

ulong GetPointCount ()

Retrieves the number of points in this volume.

Return:The number of points in this volume.

override HPS.Type ObjectType ()

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

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

void Set (HPS.EXPERIMENTAL.CellularVolumeKit in_kit)

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

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

HPS.EXPERIMENTAL.CellularVolumeKey SetCells (HPS.EXPERIMENTAL.CellElement[] in_cell_array)

Sets the cell array for this CellularVolumeKey.

Param in_cell_array:  The cell array for this CellularVolumeKey. Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey SetMaterialMapping (HPS.MaterialMappingKit 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.

Param in_kit:The material mappings to set on this CellularVolumeKey. Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey SetPoints (HPS.Point[] in_points)

Replace the points on this CellularVolumeKey with the specified points.

Param in_points:  The points to use to replace those for this CellularVolumeKey. Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey SetVertexIndexColorsByList (ulong[] in_vertices, float in_index)

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

Param 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. Param in_index:The material index to set on the vertices. Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey SetVertexIndexColorsByList (ulong[] in_vertices, float in_index, HPS.CellularVolume.Component in_apply_to)

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

Param 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. Param in_index:The material index to set on the vertices. Param in_apply_to:  The volume component the colors should apply to. Defaults to CellularVolume.Component.Faces. Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey SetVertexIndexColorsByList (ulong[] in_vertices, float[] in_indices)

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.

Param 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. Param in_indices:  The material indices to set on the vertices. Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey SetVertexIndexColorsByList (ulong[] in_vertices, float[] in_indices, HPS.CellularVolume.Component in_apply_to)

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.

Param 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. Param in_indices:  The material indices to set on the vertices. Param in_apply_to:  The volume component the colors should apply to. Defaults to CellularVolume.Component.Faces. Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey SetVertexIndexColorsByRange (ulong in_start, float[] in_indices)

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

Param 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. Param 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. Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey SetVertexIndexColorsByRange (ulong in_start, float[] in_indices, HPS.CellularVolume.Component in_apply_to)

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

Param 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. Param 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. Param in_apply_to:  The volume component the colors should apply to. Defaults to HPS.CellularVolume.Component.Faces. Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey SetVertexIndexColorsByRange (ulong in_start, ulong in_count, float in_index)

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

Param 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. Param 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. Param in_index:The material index to set on the vertices for this CellularVolumeKey. Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey SetVertexIndexColorsByRange (ulong in_start, ulong in_count, float in_index, HPS.CellularVolume.Component in_apply_to)

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

Param 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. Param 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. Param in_index:The material index to set on the vertices for this CellularVolumeKey. Param in_apply_to:  The volume component the colors should apply to. Defaults to CellularVolume.Component.Faces. Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey SetVertexParametersByList (ulong[] in_vertices, float[] in_params)

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.

Param 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. Param 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. Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey SetVertexParametersByList (ulong[] in_vertices, float[] in_params, ulong in_param_width)

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.

Param 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. Param 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. Param in_param_width:  The number of texture parameters per vertex. Defaults to 2. Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey SetVertexParametersByRange (ulong in_start, float[] in_params)

Sets texture parameters on a range of vertices starting at the specified offset.

Param 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. Param 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. Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey SetVertexParametersByRange (ulong in_start, float[] in_params, ulong in_param_width)

Sets texture parameters on a range of vertices starting at the specified offset.

Param 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. Param 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. Param in_param_width:  The number of texture parameters per vertex. Defaults to 2. Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor in_rgb_color)

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

Param 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. Param in_rgb_color:  The RGB color to set on the vertices. Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor in_rgb_color, HPS.CellularVolume.Component in_apply_to)

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

Param 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. Param in_rgb_color:  The RGB color to set on the vertices. Param in_apply_to:  The volume component the colors should apply to. Defaults to CellularVolume.Component.Faces. Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor[] in_rgb_colors)

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.

Param 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. Param in_rgb_colors:  The RGB colors to set on the vertices. Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor[] in_rgb_colors, HPS.CellularVolume.Component in_apply_to)

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.

Param 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. Param in_rgb_colors:  The RGB colors to set on the vertices. Param in_apply_to:  The volume component the colors should apply to. Defaults to CellularVolume.Component.Faces. Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey SetVertexRGBColorsByRange (ulong in_start, HPS.RGBColor[] in_rgb_colors)

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

Param 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. Param 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. Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey SetVertexRGBColorsByRange (ulong in_start, HPS.RGBColor[] in_rgb_colors, HPS.CellularVolume.Component in_apply_to)

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

Param 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. Param 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. Param in_apply_to:  The volume component the colors should apply to. Defaults to HPS.CellularVolume.Component.Faces. Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey SetVertexRGBColorsByRange (ulong in_start, ulong in_count, HPS.RGBColor in_rgb_color)

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

Param 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. Param 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. Param in_rgb_color:  The RGB color to set on the vertices for this CellularVolumeKey. Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey SetVertexRGBColorsByRange (ulong in_start, ulong in_count, HPS.RGBColor in_rgb_color, HPS.CellularVolume.Component in_apply_to)

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

Param 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. Param 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. Param in_rgb_color:  The RGB color to set on the vertices for this CellularVolumeKey. Param in_apply_to:  The volume component the colors should apply to. Defaults to CellularVolume.Component.Faces. Return:A reference to this CellularVolumeKey.

void Show (out HPS.EXPERIMENTAL.CellularVolumeKit out_kit)

Copy the contents of this CellularVolumeKey into the specified kit.

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

bool ShowCells (out HPS.EXPERIMENTAL.CellElement[] out_cell_array)

Show the cell array for this CellularVolumeKey.

Param out_cell_array:  The cell array for this CellularVolumeKey. Return:true if cell list was set, false otherwise.

bool ShowMaterialMapping (out HPS.MaterialMappingKit out_kit)

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

Param out_kit:The material mappings set on this CellularVolumeKey. Return:true if material mappings were set, false otherwise.

bool ShowPoints (out HPS.Point[] out_points)

Show the points for this CellularVolumeKey.

Param out_points:  The points for this CellularVolumeKey. Return:true if points were set, false otherwise.

bool ShowPointsByList (ulong[] in_indices, out HPS.Point[] out_points)

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

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

bool ShowPointsByRange (ulong in_start_index, ulong in_count, out HPS.Point[] out_points)

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

Param in_start_index:  The first point to show. Param in_count:The number of points to show. Param out_points:  The requested points for this CellularVolumeKey. Return:true if all requested points were set, false otherwise.

bool ShowVertexColors (HPS.CellularVolume.Component in_apply_to, out HPS.Material.Type[] out_types, out HPS.RGBColor[] out_rgb_colors, out float[] out_indices)

Shows all the vertex colors on the specified volume component.

Param in_apply_to:  The volume component the colors should apply to. Param 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. Param out_rgb_colors:  The RGB colors for each vertex. out_rgb_colors[i] is only valid if out_types[i] is Material.Type.RGBColor. Param out_indices:  The material indices for each vertex. The out_indices[i] is only valid if out_types[i] is Material.Type.MaterialIndex. Return:true if any vertex colors were shown, false otherwise.

bool ShowVertexColorsByList (ulong[] in_vertices, HPS.CellularVolume.Component in_apply_to, out HPS.Material.Type[] out_types, out HPS.RGBColor[] out_rgb_colors, out float[] out_indices)

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

Param 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. Param in_apply_to:  The volume component the colors should apply to. Param 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. Param 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. Param 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. Return:true if any specified vertex had a vertex color on the specified component set, false otherwise.

bool ShowVertexColorsByRange (ulong in_start, ulong in_count, HPS.CellularVolume.Component in_apply_to, out HPS.Material.Type[] out_types, out HPS.RGBColor[] out_rgb_colors, out float[] out_indices)

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

Param 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. Param 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. Param in_apply_to:  The volume component the colors should apply to. Param 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. Param 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. Param 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. Return:true if any vertex in the specified range had a vertex color on the specified component set, false otherwise.

bool ShowVertexParameters (out bool[] out_validities, out float[] out_params)

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.

Param 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. Param 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. Return:true if any vertex had a texture parameter set, false otherwise.

bool ShowVertexParameters (out bool[] out_validities, out float[] out_params, out ulong out_param_width)

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

Param 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. Param 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. Param out_param_width:  The number of texture parameters per vertex. Return:true if any vertex had a texture parameter set, false otherwise.

bool ShowVertexParametersByList (ulong[] in_vertices, out bool[] out_validities, out float[] out_params)

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

Param 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. Param 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. Param 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. Return:true if any specified vertex had a texture parameter set, false otherwise.

bool ShowVertexParametersByList (ulong[] in_vertices, out bool[] out_validities, out float[] out_params, out ulong out_param_width)

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

Param 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. Param 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. Param 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. Param out_param_width:  The number of texture parameters per vertex. Return:true if any specified vertex had a texture parameter set, false otherwise.

bool ShowVertexParametersByRange (ulong in_start, ulong in_count, out bool[] out_validities, out float[] out_params)

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.

Param 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. Param 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. Param 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. Param 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. Return:true if any vertex in the specified range had a texture parameter set, false otherwise.

bool ShowVertexParametersByRange (ulong in_start, ulong in_count, out bool[] out_validities, out float[] out_params, out ulong out_param_width)

Shows the texture parameters on a range of vertices starting at the specified offset.

Param 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. Param 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. Param 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. Param 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. Param out_param_width:  The number of texture parameters per vertex. Return:true if any vertex in the specified range had a texture parameter set, false otherwise.

HPS.EXPERIMENTAL.CellularVolumeKey UnsetCells ()

Removes the cells for this CellularVolumeKey.

Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey UnsetEverything ()

Removes all settings from this CellularVolumeKey.

Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.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.

Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey UnsetPoints ()

Removes the points for this CellularVolumeKey.

Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey UnsetVertexColors ()

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

Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey UnsetVertexColors (HPS.CellularVolume.Component in_apply_to)

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

Param in_apply_to:  The volume component for which to remove the colors. Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey UnsetVertexColorsByList (ulong[] in_vertices)

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

Param 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. Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey UnsetVertexColorsByList (ulong[] 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.

Param 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. Param in_apply_to:  The volume component for which to remove the colors. Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey UnsetVertexColorsByRange (ulong in_start, ulong 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.

Param 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. Param 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. Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey UnsetVertexColorsByRange (ulong in_start, ulong 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.

Param 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. Param 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. Param in_apply_to:  The volume component for which to remove the colors. Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey UnsetVertexEverything ()

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

Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey UnsetVertexParameters ()

Removes all texture parameters.

Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey UnsetVertexParametersByList (ulong[] in_vertices)

Removes the texture parameters on a selection of arbitrary vertices.

Param 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. Return:A reference to this CellularVolumeKey.

HPS.EXPERIMENTAL.CellularVolumeKey UnsetVertexParametersByRange (ulong in_start, ulong in_count)

Removes the specified range of texture parameters starting at the specified offset.

Param 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. Param 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. Return:A reference to this CellularVolumeKey.

class CellularVolumeKit : public HPS.Kit

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

.

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

Warning

Public Functions

CellularVolumeKit ()

The default constructor creates an empty CellularVolumeKit object.

CellularVolumeKit (HPS.EXPERIMENTAL.CellularVolumeKit in_kit)

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

Param in_kit:The source CellularVolumeKit to copy.

void Consume (HPS.EXPERIMENTAL.CellularVolumeKit in_kit)

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

Param in_kit:The source CellularVolumeKit to consume.

override void Dispose ()

HPS.EXPERIMENTAL.CellularVolumeKit EditCellsByDeletion (ulong in_offset, ulong 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.

Param 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. Param 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. Return:A reference to this CellularVolumeKit.

HPS.EXPERIMENTAL.CellularVolumeKit EditCellsByInsertion (ulong in_offset, HPS.EXPERIMENTAL.CellElement[] in_cell_array)

Adds cells to the cell list for this CellularVolumeKit.

Param 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. Param in_cell_array:  The cells to insert into the cell list at the specified offset. Return:A reference to this CellularVolumeKit.

HPS.EXPERIMENTAL.CellularVolumeKit EditCellsByReplacement (ulong in_offset, HPS.EXPERIMENTAL.CellElement[] in_cell_array)

Replaces cells in the cell list for this CellularVolumeKit.

Param 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. Param in_cell_array:  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. Return:A reference to this CellularVolumeKit.

HPS.EXPERIMENTAL.CellularVolumeKit EditPointsByDeletion (ulong in_offset, ulong 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 and 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.

Param 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. Param 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. Return:A reference to this CellularVolumeKit.

HPS.EXPERIMENTAL.CellularVolumeKit EditPointsByInsertion (ulong in_offset, HPS.Point[] 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.

Param 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. Param in_points:  The points to insert into the point list at the specified offset. Return:A reference to this CellularVolumeKit.

HPS.EXPERIMENTAL.CellularVolumeKit EditPointsByReplacement (ulong in_offset, HPS.Point[] 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.

Param 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. Param 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. Return:A reference to this CellularVolumeKit.

override bool Empty ()

Indicates whether this CellularVolumeKit has any values set on it.

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

bool Equals (HPS.EXPERIMENTAL.CellularVolumeKit in_kit)

Check if the source CellularVolumeKit is equivalent to this CellularVolumeKit.

Param in_kit:The source CellularVolumeKit to compare to this CellularVolumeKit. Return:true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

ulong GetCellCount ()

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

Return:The number of cells in this volume.

override int GetHashCode ()

ulong GetPointCount ()

Retrieves the number of points in this cellular volume.

Return:The number of points in this cellular volume.

override HPS.Type ObjectType ()

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

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

void Set (HPS.EXPERIMENTAL.CellularVolumeKit in_kit)

Copies the source CellularVolumeKit into this CellularVolumeKit.

Param in_kit:The source CellularVolumeKit to copy.

HPS.EXPERIMENTAL.CellularVolumeKit SetCells (HPS.EXPERIMENTAL.CellElement[] in_cell_array)

Sets the cell array for this CellularVolumeKit.

Param in_cell_array:  The cell array for this CellularVolumeKit. Return:A reference to this CellularVolumeKit.

HPS.EXPERIMENTAL.CellularVolumeKit SetMaterialMapping (HPS.MaterialMappingKit 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.

Param in_kit:The material mappings to set on this CellularVolumeKit. Return:A reference to this CellularVolumeKit.

HPS.EXPERIMENTAL.CellularVolumeKit SetPoints (HPS.Point[] in_points)

Sets the points for this CellularVolumeKit.

Param in_points:  The points for this CellularVolumeKit. Return:A reference to this CellularVolumeKit.

HPS.EXPERIMENTAL.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.SetPriority()

See also

SubwindowKit.SetRenderingAlgorithm()

See also

https://forum.techsoft3d.com/t/priority-sorting-in-3df-and-hps/5138

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

HPS.EXPERIMENTAL.CellularVolumeKit SetUserData (IntPtr in_index, byte[] in_data)

Sets user data on this kit.

Param in_index:The index of the user data to set. Param in_data:The bytes of user data to set. Return:A reference to this kit.

HPS.EXPERIMENTAL.CellularVolumeKit SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)

Sets user data on this kit.

Param in_index:The index of the user data to set. Param in_bytes:The number of bytes of user data to set. Param in_data:The bytes of user data to set. Return:A reference to this kit.

HPS.EXPERIMENTAL.CellularVolumeKit SetUserData (IntPtr[] in_indices, byte[][] in_data)

Sets user data on this kit.

Param in_indices:  An array of user data indices to set. Param in_data:An array of bytes of user data to set. Return:A reference to this kit.

HPS.EXPERIMENTAL.CellularVolumeKit SetVertexIndexColorsByList (ulong[] in_vertices, float in_index)

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

Param in_vertices:  The indices of the vertices on which to set the color. Param in_index:The material index to set on the vertices. Return:A reference to this CellularVolumeKit.

HPS.EXPERIMENTAL.CellularVolumeKit SetVertexIndexColorsByList (ulong[] in_vertices, float in_index, HPS.CellularVolume.Component in_apply_to)

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

Param in_vertices:  The indices of the vertices on which to set the color. Param in_index:The material index to set on the vertices. Param in_apply_to:  The volume component the colors should apply to. Defaults to HPS.CellularVolume.Component.Faces. Return:A reference to this CellularVolumeKit.

HPS.EXPERIMENTAL.CellularVolumeKit SetVertexIndexColorsByList (ulong[] in_vertices, float[] in_indices)

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.

Param in_vertices:  The indices of the vertices on which to set the colors. Param in_indices:  The material indices to set on the vertices. Return:A reference to this CellularVolumeKit.

HPS.EXPERIMENTAL.CellularVolumeKit SetVertexIndexColorsByList (ulong[] in_vertices, float[] in_indices, HPS.CellularVolume.Component in_apply_to)

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.

Param in_vertices:  The indices of the vertices on which to set the colors. Param in_indices:  The material indices to set on the vertices. Param in_apply_to:  The volume component the colors should apply to. Defaults to HPS.CellularVolume.Component.Faces. Return:A reference to this CellularVolumeKit.

HPS.EXPERIMENTAL.CellularVolumeKit SetVertexIndexColorsByRange (ulong in_start, float[] in_indices)

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

Param in_start:The offset into the vertices for this CellularVolumeKit at which to start setting colors. Param in_indices:  The material indices to set on the vertices for this CellularVolumeKit. Return:A reference to this CellularVolumeKit.

HPS.EXPERIMENTAL.CellularVolumeKit SetVertexIndexColorsByRange (ulong in_start, float[] in_indices, HPS.CellularVolume.Component in_apply_to)

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

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

HPS.EXPERIMENTAL.CellularVolumeKit SetVertexIndexColorsByRange (ulong in_start, ulong in_count, float in_index)

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

Param in_start:The offset into the vertices for this CellularVolumeKit at which to start setting the color. Param in_count:The number of vertices on which to set the color. Param in_index:The material index to set on the vertices for this CellularVolumeKit. Return:A reference to this CellularVolumeKit.

HPS.EXPERIMENTAL.CellularVolumeKit SetVertexIndexColorsByRange (ulong in_start, ulong in_count, float in_index, HPS.CellularVolume.Component in_apply_to)

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

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

HPS.EXPERIMENTAL.CellularVolumeKit SetVertexParametersByList (ulong[] in_vertices, float[] in_params)

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.

Param in_vertices:  The indices of the vertices on which to set the texture parameters. Param 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. Return:A reference to this CellularVolumeKit.

HPS.EXPERIMENTAL.CellularVolumeKit SetVertexParametersByList (ulong[] in_vertices, float[] in_params, ulong in_param_width)

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.

Param in_vertices:  The indices of the vertices on which to set the texture parameters. Param 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. Param in_param_width:  The number of texture parameters per vertex. Defaults to 2. Return:A reference to this CellularVolumeKit.

HPS.EXPERIMENTAL.CellularVolumeKit SetVertexParametersByRange (ulong in_start, float[] in_params)

Sets texture parameters on a range of vertices starting at the specified offset.

Param in_start:The offset into the vertices for this CellularVolumeKit at which to start setting texture parameters. Param 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. Return:A reference to this CellularVolumeKit.

HPS.EXPERIMENTAL.CellularVolumeKit SetVertexParametersByRange (ulong in_start, float[] in_params, ulong in_param_width)

Sets texture parameters on a range of vertices starting at the specified offset.

Param in_start:The offset into the vertices for this CellularVolumeKit at which to start setting texture parameters. Param 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. Param in_param_width:  The number of texture parameters per vertex. Defaults to 2. Return:A reference to this CellularVolumeKit.

HPS.EXPERIMENTAL.CellularVolumeKit SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor in_rgb_color)

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

Param in_vertices:  The indices of the vertices on which to set the color. Param in_rgb_color:  The RGB color to set on the vertices. Return:A reference to this CellularVolumeKit.

HPS.EXPERIMENTAL.CellularVolumeKit SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor in_rgb_color, HPS.CellularVolume.Component in_apply_to)

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

Param in_vertices:  The indices of the vertices on which to set the color. Param in_rgb_color:  The RGB color to set on the vertices. Param in_apply_to:  The volume component the colors should apply to. Defaults to CellularVolume.Component.Faces. Return:A reference to this CellularVolumeKit.

HPS.EXPERIMENTAL.CellularVolumeKit SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor[] in_rgb_colors)

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.

Param in_vertices:  The indices of the vertices on which to set the colors. Param in_rgb_colors:  The RGB colors to set on the vertices. Return:A reference to this CellularVolumeKit.

HPS.EXPERIMENTAL.CellularVolumeKit SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor[] in_rgb_colors, HPS.CellularVolume.Component in_apply_to)

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.

Param in_vertices:  The indices of the vertices on which to set the colors. Param in_rgb_colors:  The RGB colors to set on the vertices. Param in_apply_to:  The volume component the colors should apply to. Defaults to CellularVolume.Component.Faces. Return:A reference to this CellularVolumeKit.

HPS.EXPERIMENTAL.CellularVolumeKit SetVertexRGBColorsByRange (ulong in_start, HPS.RGBColor[] in_rgb_colors)

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

Param in_start:The offset into the vertices for this CellularVolumeKit at which to start setting colors. Param in_rgb_colors:  The RGB colors to set on the vertices for this CellularVolumeKit. Return:A reference to this CellularVolumeKit.

HPS.EXPERIMENTAL.CellularVolumeKit SetVertexRGBColorsByRange (ulong in_start, HPS.RGBColor[] in_rgb_colors, HPS.CellularVolume.Component in_apply_to)

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

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

HPS.EXPERIMENTAL.CellularVolumeKit SetVertexRGBColorsByRange (ulong in_start, ulong in_count, HPS.RGBColor in_rgb_color)

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

Param in_start:The offset into the vertices for this CellularVolumeKit at which to start setting the color. Param in_count:The number of vertices on which to set the color. Param in_rgb_color:  The RGB color to set on the vertices for this CellularVolumeKit. Return:A reference to this CellularVolumeKit.

HPS.EXPERIMENTAL.CellularVolumeKit SetVertexRGBColorsByRange (ulong in_start, ulong in_count, HPS.RGBColor in_rgb_color, HPS.CellularVolume.Component in_apply_to)

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

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

void Show (out HPS.EXPERIMENTAL.CellularVolumeKit out_kit)

Copies this CellularVolumeKit into the given CellularVolumeKit.

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

bool ShowCells (out HPS.EXPERIMENTAL.CellElement[] out_cell_array)

Show the cell array for this CellularVolumeKit.

Param out_cell_array:  The cell array for this CellularVolumeKit. Return:true if cell list was set, false otherwise.

bool ShowCellsList (out int[] out_cells_list)

Show the cell list (mixed stream of codes and indices) for this CellularVolumeKit.

Param out_cells_list:  The cell list for this CellularVolumeKit. Return:true if cell list was set, false otherwise.

bool ShowMaterialMapping (out HPS.MaterialMappingKit out_kit)

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

Param out_kit:The material mappings set on this CellularVolumeKit. Return:true if material mappings were set, false otherwise.

bool ShowPoints (out HPS.Point[] out_points)

Show the points for this CellularVolumeKit.

Param out_points:  The points for this CellularVolumeKit. Return:true if points were set, false otherwise.

bool ShowPointsByList (ulong[] in_indices, out HPS.Point[] out_points)

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

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

bool ShowPointsByRange (ulong in_start_index, ulong in_count, out HPS.Point[] out_points)

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

Param in_start_index:  The first point to show. Param in_count:The number of points to show. Param out_points:  The requested points for this CellularVolumeKit. Return:true if all requested points were set, false otherwise.

bool ShowPriority (out int out_priority)

Shows the drawing priority.

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

bool ShowUserData (IntPtr in_index, out byte[] out_data)

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

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

bool ShowUserData (out IntPtr[] out_indices, out byte[][] out_data)

Shows all user data for this kit.

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

ulong ShowUserDataCount ()

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

bool ShowUserDataIndices (out IntPtr[] out_indices)

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

Param out_indices:  The user data indices set on this kit. Return:The number of user data indices set on this kit.

bool ShowVertexColors (HPS.CellularVolume.Component in_apply_to, out HPS.Material.Type[] out_types, out HPS.RGBColor[] out_rgb_colors, out float[] out_indices)

Shows all the vertex colors on the specified volume component.

Param in_apply_to:  The volume component the colors should apply to. Param 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. Param out_rgb_colors:  The RGB colors for each vertex. out_rgb_colors[i] is only valid if out_types[i] is Material.Type.RGBColor. Param out_indices:  The material indices for each vertex. The out_indices[i] is only valid if out_types[i] is Material.Type.MaterialIndex. Return:true if any vertex colors were shown, false otherwise.

bool ShowVertexColorsByList (ulong[] in_vertices, HPS.CellularVolume.Component in_apply_to, out HPS.Material.Type[] out_types, out HPS.RGBColor[] out_rgb_colors, out float[] out_indices)

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

Param in_vertices:  The indices of the vertices on which to show the colors. Param in_apply_to:  The volume component the colors should apply to. Param 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. Param 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. Param 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. Return:true if any specified vertex had a vertex color on the specified component set, false otherwise.

bool ShowVertexColorsByRange (ulong in_start, ulong in_count, HPS.CellularVolume.Component in_apply_to, out HPS.Material.Type[] out_types, out HPS.RGBColor[] out_rgb_colors, out float[] out_indices)

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

Param in_start:The offset into the vertices for this CellularVolumeKit at which to start showing colors. Param in_count:The number of colors to show. Param in_apply_to:  The volume component the colors should apply to. Param 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. Param 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. Param 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. Return:true if any vertex in the specified range had a vertex color on the specified component set, false otherwise.

bool ShowVertexParameters (out bool[] out_validities, out float[] out_params)

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.

Param 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. Param 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. Return:true if any vertex had a texture parameter set, false otherwise.

bool ShowVertexParameters (out bool[] out_validities, out float[] out_params, out ulong out_param_width)

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

Param 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. Param 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. Param out_param_width:  The number of texture parameters per vertex. Return:true if any vertex had a texture parameter set, false otherwise.

bool ShowVertexParametersByList (ulong[] in_vertices, out bool[] out_validities, out float[] out_params)

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

Param in_vertices:  The indices of the vertices on which to show the texture parameters. Param 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. Param 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. Return:true if any specified vertex had a texture parameter set, false otherwise.

bool ShowVertexParametersByList (ulong[] in_vertices, out bool[] out_validities, out float[] out_params, out ulong out_param_width)

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

Param in_vertices:  The indices of the vertices on which to show the texture parameters. Param 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. Param 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. Param out_param_width:  The number of texture parameters per vertex. Return:true if any specified vertex had a texture parameter set, false otherwise.

bool ShowVertexParametersByRange (ulong in_start, ulong in_count, out bool[] out_validities, out float[] out_params)

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.

Param in_start:The offset into the vertices for this CellularVolumeKit at which to start showing texture parameters. Param in_count:The number of vertices for which to show the texture parameters. Param 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. Param 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. Return:true if any vertex in the specified range had a texture parameter set, false otherwise.

bool ShowVertexParametersByRange (ulong in_start, ulong in_count, out bool[] out_validities, out float[] out_params, out ulong out_param_width)

Shows the texture parameters on a range of vertices starting at the specified offset.

Param in_start:The offset into the vertices for this CellularVolumeKit at which to start showing texture parameters. Param in_count:The number of vertices for which to show the texture parameters. Param 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. Param 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. Param out_param_width:  The number of texture parameters per vertex. Return:true if any vertex in the specified range had a texture parameter set, false otherwise.

HPS.EXPERIMENTAL.CellularVolumeKit UnsetAllUserData ()

Removes all user data from this kit.

Return:A reference to this kit.

HPS.EXPERIMENTAL.CellularVolumeKit UnsetCells ()

Removes the cells for this CellularVolumeKit.

Return:A reference to this CellularVolumeKit.

HPS.EXPERIMENTAL.CellularVolumeKit UnsetEverything ()

Removes all settings from this CellularVolumeKit.

Return:A reference to this CellularVolumeKit.

HPS.EXPERIMENTAL.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.

Return:A reference to this CellularVolumeKit.

HPS.EXPERIMENTAL.CellularVolumeKit UnsetPoints ()

Removes the points for this CellularVolumeKit.

Return:A reference to this CellularVolumeKit.

HPS.EXPERIMENTAL.CellularVolumeKit UnsetPriority ()

Removes a drawing priority setting.

Return:A reference to this object.

HPS.EXPERIMENTAL.CellularVolumeKit UnsetUserData (IntPtr in_index)

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

Param in_index:The index of the user data to remove. Return:A reference to this kit.

HPS.EXPERIMENTAL.CellularVolumeKit UnsetUserData (IntPtr[] in_indices)

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

Param in_indices:  The indices of the user data to remove. Return:A reference to this kit.

HPS.EXPERIMENTAL.CellularVolumeKit UnsetVertexColors ()

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

Return:A reference to this CellularVolumeKit.

HPS.EXPERIMENTAL.CellularVolumeKit UnsetVertexColors (HPS.CellularVolume.Component in_apply_to)

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

Param in_apply_to:  The volume component for which to remove the colors. Return:A reference to this CellularVolumeKit.

HPS.EXPERIMENTAL.CellularVolumeKit UnsetVertexColorsByList (ulong[] in_vertices)

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

Param in_vertices:  The indices of the vertices on which to remove the colors. Return:A reference to this CellularVolumeKit.

HPS.EXPERIMENTAL.CellularVolumeKit UnsetVertexColorsByList (ulong[] 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.

Param in_vertices:  The indices of the vertices on which to remove the colors. Param in_apply_to:  The volume component for which to remove the colors. Return:A reference to this CellularVolumeKit.

HPS.EXPERIMENTAL.CellularVolumeKit UnsetVertexColorsByRange (ulong in_start, ulong 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.

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

HPS.EXPERIMENTAL.CellularVolumeKit UnsetVertexColorsByRange (ulong in_start, ulong 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.

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

HPS.EXPERIMENTAL.CellularVolumeKit UnsetVertexEverything ()

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

Return:A reference to this CellularVolumeKit.

HPS.EXPERIMENTAL.CellularVolumeKit UnsetVertexParameters ()

Removes all texture parameters.

Return:A reference to this CellularVolumeKit.

HPS.EXPERIMENTAL.CellularVolumeKit UnsetVertexParametersByList (ulong[] in_vertices)

Removes the texture parameters on a selection of arbitrary vertices.

Param in_vertices:  The indices of the vertices on which to remove the texture parameters. Return:A reference to this CellularVolumeKit.

HPS.EXPERIMENTAL.CellularVolumeKit UnsetVertexParametersByRange (ulong in_start, ulong in_count)

Removes the specified range of texture parameters starting at the specified offset.

Param in_start:The offset into the vertices for this CellularVolumeKit at which to start removing texture parameters. Param in_count:The number of texture parameters to remove for this CellularVolumeKit. Return:A reference to this CellularVolumeKit.

Public Static Functions

bool operator!= (HPS.EXPERIMENTAL.CellularVolumeKit a, HPS.EXPERIMENTAL.CellularVolumeKit b)

bool operator== (HPS.EXPERIMENTAL.CellularVolumeKit a, HPS.EXPERIMENTAL.CellularVolumeKit b)