< Home

< Table of Contents

REFERENCE MANUAL

HPS.CylinderKey Class Reference

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

Inheritance diagram for HPS.CylinderKey:
HPS.GeometryKey HPS.Key HPS.Object

Public Member Functions

void Consume (HPS.CylinderKit in_kit)
 Completely replaces all settings on this CylinderKey with those set on the specified kit and resets the kit. More...
 
 CylinderKey ()
 The default constructor creates an uninitialized CylinderKey object. More...
 
 CylinderKey (HPS.Key in_that)
 This constructor creates a CylinderKey object that shares the underlying smart-pointer of the source Key. More...
 
 CylinderKey (HPS.CylinderKey in_that)
 This constructor creates a CylinderKey object that shares the underlying smart-pointer of the source Key. More...
 
override void Dispose ()
 
HPS.CylinderKey EditPointsByDeletion (ulong in_offset, ulong in_count)
 Removes points from the point list for this CylinderKey. More...
 
HPS.CylinderKey EditPointsByInsertion (ulong in_offset, HPS.Point[] in_points)
 Adds points to the point list for this CylinderKey. More...
 
HPS.CylinderKey EditPointsByReplacement (ulong in_offset, HPS.Point[] in_points)
 Replaces points in the point list for this CylinderKey. More...
 
HPS.CylinderKey EditRadiiByDeletion (ulong in_offset, ulong in_count)
 Removes radii from the radius list for this CylinderKey. More...
 
HPS.CylinderKey EditRadiiByInsertion (ulong in_offset, float[] in_radii)
 Adds radii to the radius list for this CylinderKey. More...
 
HPS.CylinderKey EditRadiiByReplacement (ulong in_offset, float[] in_radii)
 Replaces radii in the radius list for this CylinderKey. More...
 
ulong GetPointCount ()
 Retrieves the number of points in this cylinder. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
void Set (HPS.CylinderKit in_kit)
 Replace those settings on this CylinderKey with those set on the specified kit. More...
 
HPS.CylinderKey SetVertexIndexColorsByRange (ulong in_start, float[] in_indices, HPS.Cylinder.Component in_apply_to)
 Sets vertex material indices on a range of vertices starting at the specified offset which apply to the specified cylinder component. More...
 
HPS.CylinderKey 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 cylinder component. More...
 
HPS.CylinderKey SetVertexIndexColorsByRange (ulong in_start, ulong in_count, float in_index, HPS.Cylinder.Component in_apply_to)
 Sets a single material index on a range of vertices starting at the specified offset which apply to the specified cylinder component. More...
 
HPS.CylinderKey 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 cylinder component. More...
 
HPS.CylinderKey SetVertexRGBColorsByRange (ulong in_start, HPS.RGBColor[] in_rgb_colors, HPS.Cylinder.Component in_apply_to)
 Sets vertex RGB colors on a range of vertices starting at the specified offset which apply to the specified cylinder component. More...
 
HPS.CylinderKey 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 cylinder component. More...
 
HPS.CylinderKey SetVertexRGBColorsByRange (ulong in_start, ulong in_count, HPS.RGBColor in_rgb_color, HPS.Cylinder.Component in_apply_to)
 Sets a single RGB color on a range of vertices starting at the specified offset which apply to the specified cylinder component. More...
 
HPS.CylinderKey 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 cylinder component. More...
 
void Show (out HPS.CylinderKit out_kit)
 Copy the contents of this CylinderKey into the specified kit. More...
 
bool ShowCaps (out HPS.Cylinder.Capping out_caps)
 Show the capping for this CylinderKey. More...
 
bool ShowPoints (out HPS.Point[] out_points)
 Show the points for this CylinderKey. More...
 
bool ShowRadii (out float[] out_radii)
 Show the radii for this CylinderKey. More...
 
bool ShowVertexColorsByList (ulong[] in_vertices, HPS.Cylinder.Component in_applied_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 cylinder component. More...
 
bool ShowVertexColorsByRange (ulong in_start, ulong in_count, HPS.Cylinder.Component in_applied_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 cylinder component. More...
 
HPS.CylinderKey UnsetVertexColors ()
 Removes all vertex colors (RGB colors or material indices) for all cylinder components. More...
 
HPS.CylinderKey UnsetVertexColors (HPS.Cylinder.Component in_apply_to)
 Removes all vertex colors (RGB colors or material indices) for the specified cylinder component. More...
 
HPS.CylinderKey UnsetVertexColorsByRange (ulong in_start, ulong in_count)
 Removes the specified range of vertex colors (RGB colors or material indices) for all cylinder components starting at the specified offset. More...
 
HPS.CylinderKey UnsetVertexColorsByRange (ulong in_start, ulong in_count, HPS.Cylinder.Component in_apply_to)
 Removes the specified range of vertex colors (RGB colors or material indices) for the specified cylinder component starting at the specified offset. More...
 
- Public Member Functions inherited from HPS.GeometryKey
override void Dispose ()
 
 GeometryKey ()
 The default constructor creates an uninitialized GeometryKey object. More...
 
 GeometryKey (HPS.Key in_that)
 This constructor creates a GeometryKey object that shares the underlying smart-pointer of the source Key. More...
 
 GeometryKey (HPS.GeometryKey in_that)
 This constructor creates a GeometryKey object that shares the underlying smart-pointer of the source Key. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
HPS.GeometryKey SetPriority (int in_priority)
 Assigns a drawing priority value to the geometry. More...
 
HPS.GeometryKey SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)
 Sets user data on this key. More...
 
HPS.GeometryKey SetUserData (IntPtr in_index, byte[] in_data)
 Sets user data on this key. More...
 
HPS.GeometryKey SetUserData (IntPtr[] in_indices, byte[][] in_data)
 Sets user data on this key. More...
 
bool ShowBoundings (out HPS.BoundingKit out_kit)
 Shows the bounding of this geometry. More...
 
bool ShowPriority (out int out_priority)
 Shows the drawing priority. More...
 
ulong ShowReferrers (out HPS.SegmentKey[] out_segments)
 Shows the all the segments which contain references to this key. More...
 
ulong ShowReferrers (out HPS.ReferenceKey[] out_references)
 Shows the all the references to this key. More...
 
bool ShowUserData (IntPtr in_index, out byte[] out_data)
 Shows the user data at a given index for this key. More...
 
bool ShowUserData (out IntPtr[] out_indices, out byte[][] out_data)
 Shows all user data for this key. More...
 
ulong ShowUserDataCount ()
 Get the number of user data indices set on this key. More...
 
bool ShowUserDataIndices (out IntPtr[] out_indices)
 Shows the indices of all user data set on this key. More...
 
HPS.GeometryKey UnsetAllUserData ()
 Removes all user data from this key. More...
 
HPS.GeometryKey UnsetPriority ()
 Removes the drawing priority setting. More...
 
HPS.GeometryKey UnsetUserData (IntPtr in_index)
 Removes the user data at the given index from this key. More...
 
HPS.GeometryKey UnsetUserData (IntPtr[] in_indices)
 Removes the user data at the given indices from this key. More...
 
- Public Member Functions inherited from HPS.Key
virtual void Assign (HPS.Key in_that)
 Share the smart-pointer. More...
 
HPS.Key CopyTo (HPS.SegmentKey in_destination)
 Copies the database object referred to by this key into a segment pointed to by in_destination. More...
 
void Delete ()
 Removes the database object referred to by this key. More...
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Key in_that)
 Determines whether the database objects pointed to by this key and in_that are the same. More...
 
ulong GetHash ()
 Returns a hash code for the key. More...
 
override int GetHashCode ()
 
bool HasOwner ()
 
Returns
Indicates whether this key has an owner or not.

 
 Key ()
 An uninitialized key refers to no database object and Type() will return Type::None. More...
 
 Key (HPS.Key in_that)
 Shares a reference to a database object referred to by in_that. More...
 
 Key (HPS.Control in_control)
 Initializes a key tied to the Control in_control. More...
 
void MoveTo (HPS.SegmentKey in_new_owner)
 Moves the database object referred to by this key into a new containing segment pointed to by in_new_owner. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
HPS.SegmentKey Owner ()
 
Returns
The segment containing this key.

 
HPS.SegmentKey Up ()
 
Returns
The segment containing this key.

 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. More...
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.GeometryKey
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Key
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Key
static bool operator!= (HPS.Key a, HPS.Key b)
 
static bool operator== (HPS.Key a, HPS.Key b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

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

It is a handle to a cylinder inserted via SegmentKey::InsertCylinder.

Constructor & Destructor Documentation

HPS.CylinderKey.CylinderKey ( )

The default constructor creates an uninitialized CylinderKey object.

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

HPS.CylinderKey.CylinderKey ( HPS.Key  in_that)

This constructor creates a CylinderKey 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 Cylinder key. Otherwise the copy will fail and the resulting CylinderKey will be invalid.

HPS.CylinderKey.CylinderKey ( HPS.CylinderKey  in_that)

This constructor creates a CylinderKey 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 Cylinder key. Otherwise the copy will fail and the resulting CylinderKey will be invalid.

Member Function Documentation

void HPS.CylinderKey.Consume ( HPS.CylinderKit  in_kit)

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

Parameters
in_kitThe kit from which to get the settings to replace on this <ref refid="class_h_p_s_1_1_cylinder_key" kindref="compound">CylinderKey</ref>.
HPS.CylinderKey HPS.CylinderKey.EditPointsByDeletion ( ulong  in_offset,
ulong  in_count 
)

Removes points from the point list for this CylinderKey.

Parameters
in_offsetThe offset into the point list for the cylinder at which to start removing points. This value must be such that in_offset<point_count for deletion to succeed.
in_countThe number of points to delete from the point list for the cylinder. This value must be such that in_offset+in_count<=point_count for the deletion to succeed.
Returns
A reference to this CylinderKey.
HPS.CylinderKey HPS.CylinderKey.EditPointsByInsertion ( ulong  in_offset,
HPS.Point[]  in_points 
)

Adds points to the point list for this CylinderKey.

Parameters
in_offsetThe offset into the point list for the cylinder at which to insert points. This value must be such that in_offset<point_count for insertion to succeed.
in_countSize of the following array.
in_pointsThe points to insert into the point list at the specified offset.
Returns
A reference to this CylinderKey.
HPS.CylinderKey HPS.CylinderKey.EditPointsByReplacement ( ulong  in_offset,
HPS.Point[]  in_points 
)

Replaces points in the point list for this CylinderKey.

Parameters
in_offsetThe offset into the point list for the cylidner at which to start replacing points. This value must be such that in_offset<point_count for replacement to succeed.
in_countSize of the following array. This value must be such that in_offset+in_count<=point_count for the replacement to succeed.
in_pointsThe points to use to replace those in the point list at the specified offset.
Returns
A reference to this CylinderKey.
HPS.CylinderKey HPS.CylinderKey.EditRadiiByDeletion ( ulong  in_offset,
ulong  in_count 
)

Removes radii from the radius list for this CylinderKey.

Parameters
in_offsetThe offset into the radius list for the cylinder at which to start removing radii. This value must be such that in_offset<radius_count for deletion to succeed.
in_countThe number of radii to delete from the radius list for the cylinder. This value must be such that in_offset+in_count<=radius_count for the deletion to succeed.
Returns
A reference to this CylinderKey.
HPS.CylinderKey HPS.CylinderKey.EditRadiiByInsertion ( ulong  in_offset,
float[]  in_radii 
)

Adds radii to the radius list for this CylinderKey.

Parameters
in_offsetThe offset into the radius list for the cylinder at which to insert radii. This value must be such that in_offset<radius_count for insertion to succeed.
in_countSize of the following array.
in_radiiThe radii to insert into the radius list at the specified offset.
Returns
A reference to this CylinderKey.
HPS.CylinderKey HPS.CylinderKey.EditRadiiByReplacement ( ulong  in_offset,
float[]  in_radii 
)

Replaces radii in the radius list for this CylinderKey.

Parameters
in_offsetThe offset into the radius list for the cylidner at which to start replacing radii. This value must be such that in_offset<radius_count for replacement to succeed.
in_countSize of the following array. This value must be such that in_offset+in_count<=radius_count for the replacement to succeed.
in_radiiThe radii to use to replace those in the radius list at the specified offset.
Returns
A reference to this CylinderKey.
ulong HPS.CylinderKey.GetPointCount ( )

Retrieves the number of points in this cylinder.

Returns
The number of points in this cylinder.
override HPS.Type HPS.CylinderKey.ObjectType ( )
virtual

This function returns the type the object, as declared.

This does not necessarily give the true type of the underlying object.

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

Reimplemented from HPS.Object.

void HPS.CylinderKey.Set ( HPS.CylinderKit  in_kit)

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

Parameters
in_kitThe kit from which to get the settings to replace on this <ref refid="class_h_p_s_1_1_cylinder_key" kindref="compound">CylinderKey</ref>.
HPS.CylinderKey HPS.CylinderKey.SetVertexIndexColorsByRange ( ulong  in_start,
float[]  in_indices,
HPS.Cylinder.Component  in_apply_to 
)

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

Parameters
in_startThe offset into the vertices for this <ref refid="class_h_p_s_1_1_cylinder_key" kindref="compound">CylinderKey</ref> at which to start setting colors. This value must be such that in_start<point_count for setting to succeed.
in_countSize of the following array. This value must be such that in_start+in_count<=point_count for the setting to succeed.
in_indicesThe material indices to set on the vertices for this <ref refid="class_h_p_s_1_1_cylinder_key" kindref="compound">CylinderKey</ref>.
in_apply_toThe cylinder component the colors should apply to. Defaults to <ref refid="class_h_p_s_1_1_cylinder_1ab47e3177b438e2b75d3abc8613dcf2e5a4f93ea0836ba76b6f9b81e3eee53a3af" kindref="member">Cylinder::Component::Faces</ref>.
Returns
A reference to this CylinderKey.
HPS.CylinderKey HPS.CylinderKey.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 cylinder component.

Parameters
in_startThe offset into the vertices for this <ref refid="class_h_p_s_1_1_cylinder_key" kindref="compound">CylinderKey</ref> at which to start setting colors. This value must be such that in_start<point_count for setting to succeed.
in_countSize of the following array. This value must be such that in_start+in_count<=point_count for the setting to succeed.
in_indicesThe material indices to set on the vertices for this <ref refid="class_h_p_s_1_1_cylinder_key" kindref="compound">CylinderKey</ref>.
Returns
A reference to this CylinderKey.
HPS.CylinderKey HPS.CylinderKey.SetVertexIndexColorsByRange ( ulong  in_start,
ulong  in_count,
float  in_index,
HPS.Cylinder.Component  in_apply_to 
)

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

Parameters
in_startThe offset into the vertices for this <ref refid="class_h_p_s_1_1_cylinder_key" kindref="compound">CylinderKey</ref> at which to start setting the color. This value must be such that in_start<point_count for setting to succeed.
in_countThe 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_indexThe material index to set on the vertices for this <ref refid="class_h_p_s_1_1_cylinder_key" kindref="compound">CylinderKey</ref>.
in_apply_toThe cylinder component the colors should apply to. Defaults to <ref refid="class_h_p_s_1_1_cylinder_1ab47e3177b438e2b75d3abc8613dcf2e5a4f93ea0836ba76b6f9b81e3eee53a3af" kindref="member">Cylinder::Component::Faces</ref>.
Returns
A reference to this CylinderKey.
HPS.CylinderKey HPS.CylinderKey.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 cylinder component.

Parameters
in_startThe offset into the vertices for this <ref refid="class_h_p_s_1_1_cylinder_key" kindref="compound">CylinderKey</ref> at which to start setting the color. This value must be such that in_start<point_count for setting to succeed.
in_countThe 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_indexThe material index to set on the vertices for this <ref refid="class_h_p_s_1_1_cylinder_key" kindref="compound">CylinderKey</ref>.
Returns
A reference to this CylinderKey.
HPS.CylinderKey HPS.CylinderKey.SetVertexRGBColorsByRange ( ulong  in_start,
HPS.RGBColor[]  in_rgb_colors,
HPS.Cylinder.Component  in_apply_to 
)

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

Parameters
in_startThe offset into the vertices for this <ref refid="class_h_p_s_1_1_cylinder_key" kindref="compound">CylinderKey</ref> at which to start setting colors. This value must be such that in_start<point_count for setting to succeed.
in_countSize of the following array. This value must be such that in_start+in_count<=point_count for the setting to succeed.
in_rgb_colorsThe RGB colors to set on the vertices for this <ref refid="class_h_p_s_1_1_cylinder_key" kindref="compound">CylinderKey</ref>.
in_apply_toThe cylinder component the colors should apply to. Defaults to Cylilnder::Component::Faces.
Returns
A reference to this CylinderKey.
HPS.CylinderKey HPS.CylinderKey.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 cylinder component.

Parameters
in_startThe offset into the vertices for this <ref refid="class_h_p_s_1_1_cylinder_key" kindref="compound">CylinderKey</ref> at which to start setting colors. This value must be such that in_start<point_count for setting to succeed.
in_countSize of the following array. This value must be such that in_start+in_count<=point_count for the setting to succeed.
in_rgb_colorsThe RGB colors to set on the vertices for this <ref refid="class_h_p_s_1_1_cylinder_key" kindref="compound">CylinderKey</ref>.
Returns
A reference to this CylinderKey.
HPS.CylinderKey HPS.CylinderKey.SetVertexRGBColorsByRange ( ulong  in_start,
ulong  in_count,
HPS.RGBColor  in_rgb_color,
HPS.Cylinder.Component  in_apply_to 
)

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

Parameters
in_startThe offset into the vertices for this <ref refid="class_h_p_s_1_1_cylinder_key" kindref="compound">CylinderKey</ref> at which to start setting the color. This value must be such that in_start<point_count for setting to succeed.
in_countThe 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_colorThe RGB color to set on the vertices for this <ref refid="class_h_p_s_1_1_cylinder_key" kindref="compound">CylinderKey</ref>.
in_apply_toThe cylinder component the colors should apply to. Defaults to <ref refid="class_h_p_s_1_1_cylinder_1ab47e3177b438e2b75d3abc8613dcf2e5a4f93ea0836ba76b6f9b81e3eee53a3af" kindref="member">Cylinder::Component::Faces</ref>.
Returns
A reference to this CylinderKey.
HPS.CylinderKey HPS.CylinderKey.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 cylinder component.

Parameters
in_startThe offset into the vertices for this <ref refid="class_h_p_s_1_1_cylinder_key" kindref="compound">CylinderKey</ref> at which to start setting the color. This value must be such that in_start<point_count for setting to succeed.
in_countThe 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_colorThe RGB color to set on the vertices for this <ref refid="class_h_p_s_1_1_cylinder_key" kindref="compound">CylinderKey</ref>.
Returns
A reference to this CylinderKey.
void HPS.CylinderKey.Show ( out HPS.CylinderKit  out_kit)

Copy the contents of this CylinderKey into the specified kit.

Parameters
out_kitThe kit to populate with the contents of this <ref refid="class_h_p_s_1_1_cylinder_key" kindref="compound">CylinderKey</ref>.
bool HPS.CylinderKey.ShowCaps ( out HPS.Cylinder.Capping  out_caps)

Show the capping for this CylinderKey.

Parameters
out_capsThe capping for this <ref refid="class_h_p_s_1_1_cylinder_key" kindref="compound">CylinderKey</ref>.
Returns
true if a capping was set, false otherwise.
bool HPS.CylinderKey.ShowPoints ( out HPS.Point[]  out_points)

Show the points for this CylinderKey.

Parameters
out_pointsThe points for this <ref refid="class_h_p_s_1_1_cylinder_key" kindref="compound">CylinderKey</ref>.
Returns
true if points were set, false otherwise.
bool HPS.CylinderKey.ShowRadii ( out float[]  out_radii)

Show the radii for this CylinderKey.

Parameters
out_radiiThe radii for this <ref refid="class_h_p_s_1_1_cylinder_key" kindref="compound">CylinderKey</ref>.
Returns
true if radii were set, false otherwise.
bool HPS.CylinderKey.ShowVertexColorsByList ( ulong[]  in_vertices,
HPS.Cylinder.Component  in_applied_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 cylinder 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], and out_indices[i], correspond to the vertex at index in_vertices[i].

Parameters
in_verticesThe indices of the vertices on which to show the colors.
in_applied_toThe cylinder component the colors should apply to.
out_typesThe 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 <ref refid="class_h_p_s_1_1_material_1a2ec9b893c8c5b2e37ec82aff0c82a18daf80a4ad87fee7c9fdc19b7769495fdb5" kindref="member">Material::Type::Nothing</ref>.
out_rgb_colorsThe RGB colors for each vertex at the specified index. out_rgb_colors[i] is only valid if out_types[i] is <ref refid="class_h_p_s_1_1_material_1a2ec9b893c8c5b2e37ec82aff0c82a18da675716a4db2321401bb4c4924e6ea710" kindref="member">Material::Type::ExplicitRGBColor</ref>.
out_indicesThe material indices for each vertex at the specified index. The out_indices[i] is only valid if out_types[i] is <ref refid="class_h_p_s_1_1_material_1a2ec9b893c8c5b2e37ec82aff0c82a18da3e21f60632b7774f92151ddc6b0c64b5" kindref="member">Material::Type::MaterialIndex</ref>.
Returns
true if any specified vertex had a vertex color on the specified component set, false otherwise.
bool HPS.CylinderKey.ShowVertexColorsByRange ( ulong  in_start,
ulong  in_count,
HPS.Cylinder.Component  in_applied_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 cylinder component.

Parameters
in_startThe offset into the vertices for this <ref refid="class_h_p_s_1_1_cylinder_key" kindref="compound">CylinderKey</ref> at which to start showing colors. This value must be such that in_start<point_count for showing to succeed.
in_countThe number of colors to show. This value must be such that in_start+in_count<=point_count for showing to succeed.
in_applied_toThe cylinder component the colors should apply to.
out_typesThe 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 cylinder component, the entry in this array will be <ref refid="class_h_p_s_1_1_material_1a2ec9b893c8c5b2e37ec82aff0c82a18daf80a4ad87fee7c9fdc19b7769495fdb5" kindref="member">Material::Type::Nothing</ref>.
out_rgb_colorsThe RGB colors for each vertex in the specified range. out_rgb_colors[i] is only valid if out_types[i] is <ref refid="class_h_p_s_1_1_material_1a2ec9b893c8c5b2e37ec82aff0c82a18da675716a4db2321401bb4c4924e6ea710" kindref="member">Material::Type::ExplicitRGBColor</ref>.
out_indicesThe material indices for each vertex in the specified range. The out_indices[i] is only valid if out_types[i] is <ref refid="class_h_p_s_1_1_material_1a2ec9b893c8c5b2e37ec82aff0c82a18da3e21f60632b7774f92151ddc6b0c64b5" kindref="member">Material::Type::MaterialIndex</ref>.
Returns
true if any vertex in the specified range had a vertex color on the specified component set, false otherwise.
HPS.CylinderKey HPS.CylinderKey.UnsetVertexColors ( )

Removes all vertex colors (RGB colors or material indices) for all cylinder components.

Returns
A reference to this CylinderKey.
HPS.CylinderKey HPS.CylinderKey.UnsetVertexColors ( HPS.Cylinder.Component  in_apply_to)

Removes all vertex colors (RGB colors or material indices) for the specified cylinder component.

Parameters
in_apply_toThe cylinder component for which to remove the colors.
Returns
A reference to this CylinderKey.
HPS.CylinderKey HPS.CylinderKey.UnsetVertexColorsByRange ( ulong  in_start,
ulong  in_count 
)

Removes the specified range of vertex colors (RGB colors or material indices) for all cylinder components starting at the specified offset.

Parameters
in_startThe offset into the vertices for this <ref refid="class_h_p_s_1_1_cylinder_key" kindref="compound">CylinderKey</ref> at which to start removing colors. This value must be such that in_start<point_count for unsetting to succeed.
in_countThe number of vertex colors to remove for this <ref refid="class_h_p_s_1_1_cylinder_key" kindref="compound">CylinderKey</ref>. This value must be such that in_start+in_count<=point_count for unsetting to succeed.
Returns
A reference to this CylinderKey.
HPS.CylinderKey HPS.CylinderKey.UnsetVertexColorsByRange ( ulong  in_start,
ulong  in_count,
HPS.Cylinder.Component  in_apply_to 
)

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

Parameters
in_startThe offset into the vertices for this <ref refid="class_h_p_s_1_1_cylinder_key" kindref="compound">CylinderKey</ref> at which to start removing colors. This value must be such that in_start<point_count for unsetting to succeed.
in_countThe number of vertex colors to remove for this <ref refid="class_h_p_s_1_1_cylinder_key" kindref="compound">CylinderKey</ref>. This value must be such that in_start+in_count<=point_count for unsetting to succeed.
in_apply_toThe cylinder component for which to remove the colors.
Returns
A reference to this CylinderKey.

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