
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. The Type() function will return Type.None. More... | |
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. More... | |
CylinderKey (HPS.CylinderKey in_that) | |
The copy constructor creates a CylinderKey object that shares the underlying smart-pointer of the source CylinderKey. 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 (if the object is derived, this does not give the true type of the derived object). More... | |
void | Set (HPS.CylinderKit in_kit) |
Replace those settings on this CylinderKey with those set on the specified kit. More... | |
HPS.CylinderKey | SetVertexIndexColorsByList (ulong[] in_vertices, float[] in_indices, HPS.Cylinder.Component in_apply_to) |
Sets vertex material indices on a selection of arbitrary vertices which apply to the specified cylinder component. More... | |
HPS.CylinderKey | SetVertexIndexColorsByList (ulong[] in_vertices, float[] in_indices) |
Sets vertex material indices on a selection of arbitrary vertices which apply to the specified cylinder component. More... | |
HPS.CylinderKey | SetVertexIndexColorsByList (ulong[] in_vertices, float in_index, HPS.Cylinder.Component in_apply_to) |
Sets vertex material indices on a selection of arbitrary vertices which apply to the specified cylinder component. More... | |
HPS.CylinderKey | SetVertexIndexColorsByList (ulong[] in_vertices, float in_index) |
Sets vertex material indices on a selection of arbitrary vertices which apply to the specified cylinder component. 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 | SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor[] in_rgb_colors, HPS.Cylinder.Component in_apply_to) |
Sets vertex RGB colors on a selection of arbitrary vertices which apply to the specified cylinder component. More... | |
HPS.CylinderKey | SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor[] in_rgb_colors) |
Sets vertex RGB colors on a selection of arbitrary vertices which apply to the specified cylinder component. More... | |
HPS.CylinderKey | SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor in_rgb_color, HPS.Cylinder.Component in_apply_to) |
Sets vertex RGB colors on a selection of arbitrary vertices which apply to the specified cylinder component. More... | |
HPS.CylinderKey | SetVertexRGBColorsByList (ulong[] in_vertices, HPS.RGBColor in_rgb_color) |
Sets vertex RGB colors on a selection of arbitrary vertices 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 | ShowPointsByList (ulong[] in_indices, out HPS.Point[] out_points) |
Show a subset of the points for this CylinderKey by list. More... | |
bool | ShowPointsByRange (ulong in_start_index, ulong in_count, out HPS.Point[] out_points) |
Show a subset of the points for this CylinderKey by range. More... | |
bool | ShowRadii (out float[] out_radii) |
Show the radii for this CylinderKey. More... | |
bool | ShowVertexColors (HPS.Cylinder.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 of the specified cylinder component. More... | |
bool | ShowVertexColorsByList (ulong[] in_vertices, HPS.Cylinder.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 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]. More... | |
bool | ShowVertexColorsByRange (ulong in_start, ulong in_count, HPS.Cylinder.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 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 | UnsetVertexColorsByList (ulong[] in_vertices) |
Removes the vertex visibilities on a selection of arbitrary vertices. More... | |
HPS.CylinderKey | UnsetVertexColorsByList (ulong[] in_vertices, HPS.Cylinder.Component in_apply_to) |
Removes the vertex visibilities on a selection of arbitrary vertices. 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... | |
![]() | |
override void | Dispose () |
GeometryKey () | |
The default constructor creates an uninitialized GeometryKey object. The Type() function will return Type.None. More... | |
GeometryKey (HPS.Key in_that) | |
This constructor creates a GeometryKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really a type of geometry key. Otherwise the copy will fail and the resulting GeometryKey will be invalid. More... | |
GeometryKey (HPS.GeometryKey in_that) | |
The copy constructor creates a GeometryKey object that shares the underlying smart-pointer of the source GeometryKey. More... | |
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). More... | |
HPS.GeometryKey | SetPriority (int in_priority) |
Assigns a drawing priority value to the geometry. It affects the order in which the geometry is visited if and only if the rendering algorithm is set to Priority. The geometry has a default drawing priority assigned, based on the order of insertion. 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 | ShowBounding (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. Note that while a segment may only appear once in the returned array, that segment could have multiple 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... | |
![]() | |
virtual void | Assign (HPS.Key in_that) |
Share the underlying smart-pointer of the Key source. 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. Empty keys (when key.Empty() returns true) are never equal to any key, even when the key is compared against itself (they act analogously to NaN comparisons in this case.) More... | |
ulong | GetHash () |
Returns a hash code for the key. More... | |
override int | GetHashCode () |
bool | HasOwner () |
| |
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 associated 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 (if the object is derived, this does not give the true type of the derived object). More... | |
HPS.SegmentKey | Owner () |
| |
HPS.SegmentKey | Up () |
| |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
virtual HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
override void | deleteCptr () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static bool | operator!= (HPS.Key a, HPS.Key b) |
static bool | operator== (HPS.Key a, HPS.Key b) |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
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
|
inline |
The default constructor creates an uninitialized CylinderKey object. The Type() function will return Type.None.
|
inline |
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.
|
inline |
The copy constructor creates a CylinderKey object that shares the underlying smart-pointer of the source CylinderKey.
- Parameters
-
in_that The source CylinderKey to copy.
Member Function Documentation
|
inline |
Completely replaces all settings on this CylinderKey with those set on the specified kit and resets the kit.
- Parameters
-
in_kit The kit from which to get the settings to replace on this CylinderKey.
|
inline |
Removes points from the point list for this CylinderKey.
- Parameters
-
in_offset The 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_count The 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.
|
inline |
Adds points to the point list for this CylinderKey.
- Parameters
-
in_offset The 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_points The points to insert into the point list at the specified offset.
- Returns
- A reference to this CylinderKey.
|
inline |
Replaces points in the point list for this CylinderKey.
- Parameters
-
in_offset The 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_points The points to use to replace those in the point list at the specified offset. This size of the array must be such that in_offset+in_points.size()<=point_count for the replacement to succeed.
- Returns
- A reference to this CylinderKey.
|
inline |
Removes radii from the radius list for this CylinderKey.
- Parameters
-
in_offset The 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_count The 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.
|
inline |
Adds radii to the radius list for this CylinderKey.
- Parameters
-
in_offset The 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_radii The radii to insert into the radius list at the specified offset.
- Returns
- A reference to this CylinderKey.
|
inline |
Replaces radii in the radius list for this CylinderKey.
- Parameters
-
in_offset The 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_radii The radii to use to replace those in the radius list at the specified offset. This size of the array must be such that in_offset+in_points.size()<=radius_count for the replacement to succeed.
- Returns
- A reference to this CylinderKey.
|
inline |
Retrieves the number of points in this cylinder.
- Returns
- The number of points in this cylinder.
|
inlinevirtual |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Object.
|
inline |
Replace those settings on this CylinderKey with those set on the specified kit.
- Parameters
-
in_kit The kit from which to get the settings to replace on this CylinderKey.
|
inline |
Sets vertex material indices on a selection of arbitrary vertices which apply to the specified cylinder component.
- Parameters
-
in_vertices The indices of the vertices on which to set the colors. in_indices The material indices to set on the vertices. in_apply_to The cylinder component the colors should apply to. Defaults to Cylinder.Component.Faces.
- Returns
- A reference to this CylinderKey.
|
inline |
Sets vertex material indices on a selection of arbitrary vertices which apply to the specified cylinder component.
- Parameters
-
in_vertices The indices of the vertices on which to set the colors. in_indices The material indices to set on the vertices.
- Returns
- A reference to this CylinderKey.
|
inline |
Sets vertex material indices on a selection of arbitrary vertices which apply to the specified cylinder component.
- Parameters
-
in_vertices The indices of the vertices on which to set the colors. in_index The material index to set on the vertices. in_apply_to The cylinder component the colors should apply to. Defaults to Cylinder.Component.Faces.
- Returns
- A reference to this CylinderKey.
|
inline |
Sets vertex material indices on a selection of arbitrary vertices which apply to the specified cylinder component.
- Parameters
-
in_vertices The indices of the vertices on which to set the colors. in_index The material index to set on the vertices.
- Returns
- A reference to this CylinderKey.
|
inline |
Sets vertex material indices on a range of vertices starting at the specified offset which apply to the specified cylinder component.
- Parameters
-
in_start The offset into the vertices for this CylinderKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed. in_indices The material indices to set on the vertices for this CylinderKey. The size of the array must be such that in_start+in_indices.size()<=point_count for the setting to succeed. in_apply_to The cylinder component the colors should apply to. Defaults to Cylinder.Component.Faces.
- Returns
- A reference to this CylinderKey.
|
inline |
Sets vertex material indices on a range of vertices starting at the specified offset which apply to the specified cylinder component.
- Parameters
-
in_start The offset into the vertices for this CylinderKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed. in_indices The material indices to set on the vertices for this CylinderKey. The size of the array must be such that in_start+in_indices.size()<=point_count for the setting to succeed.
- Returns
- A reference to this CylinderKey.
|
inline |
Sets a single material index on a range of vertices starting at the specified offset which apply to the specified cylinder component.
- Parameters
-
in_start The offset into the vertices for this CylinderKey at which to start setting the color. This value must be such that in_start<point_count for setting to succeed. in_count The number of vertices on which to set the color. This value must be such that in_start+in_count<=point_count for the setting to succeed. in_index The material index to set on the vertices for this CylinderKey. in_apply_to The cylinder component the colors should apply to. Defaults to Cylinder.Component.Faces.
- Returns
- A reference to this CylinderKey.
|
inline |
Sets a single material index on a range of vertices starting at the specified offset which apply to the specified cylinder component.
- Parameters
-
in_start The offset into the vertices for this CylinderKey at which to start setting the color. This value must be such that in_start<point_count for setting to succeed. in_count The number of vertices on which to set the color. This value must be such that in_start+in_count<=point_count for the setting to succeed. in_index The material index to set on the vertices for this CylinderKey.
- Returns
- A reference to this CylinderKey.
|
inline |
Sets vertex RGB colors on a selection of arbitrary vertices which apply to the specified cylinder component.
- Parameters
-
in_vertices The indices of the vertices on which to set the colors. in_rgb_colors The RGB colors to set on the vertices. in_apply_to The cylinder component the colors should apply to. Defaults to Cylinder.Component.Faces.
- Returns
- A reference to this CylinderKey.
|
inline |
Sets vertex RGB colors on a selection of arbitrary vertices which apply to the specified cylinder component.
- Parameters
-
in_vertices The indices of the vertices on which to set the colors. in_rgb_colors The RGB colors to set on the vertices.
- Returns
- A reference to this CylinderKey.
|
inline |
Sets vertex RGB colors on a selection of arbitrary vertices which apply to the specified cylinder component.
- Parameters
-
in_vertices The indices of the vertices on which to set the colors. in_rgb_color The RGB color to set on the vertices. in_apply_to The cylinder component the colors should apply to. Defaults to Cylinder.Component.Faces.
- Returns
- A reference to this CylinderKey.
|
inline |
Sets vertex RGB colors on a selection of arbitrary vertices which apply to the specified cylinder component.
- Parameters
-
in_vertices The indices of the vertices on which to set the colors. in_rgb_color The RGB color to set on the vertices.
- Returns
- A reference to this CylinderKey.
|
inline |
Sets vertex RGB colors on a range of vertices starting at the specified offset which apply to the specified cylinder component.
- Parameters
-
in_start The offset into the vertices for this CylinderKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed. in_rgb_colors The RGB colors to set on the vertices for this CylinderKey. The size of the array must be such that in_start+in_rgb_colors.size()<=point_count for the setting to succeed. in_apply_to The shell component the colors should apply to. Defaults to Cylinder.Component.Faces.
- Returns
- A reference to this CylinderKey.
|
inline |
Sets vertex RGB colors on a range of vertices starting at the specified offset which apply to the specified cylinder component.
- Parameters
-
in_start The offset into the vertices for this CylinderKey at which to start setting colors. This value must be such that in_start<point_count for setting to succeed. in_rgb_colors The RGB colors to set on the vertices for this CylinderKey. The size of the array must be such that in_start+in_rgb_colors.size()<=point_count for the setting to succeed.
- Returns
- A reference to this CylinderKey.
|
inline |
Sets a single RGB color on a range of vertices starting at the specified offset which apply to the specified cylinder component.
- Parameters
-
in_start The offset into the vertices for this CylinderKey at which to start setting the color. This value must be such that in_start<point_count for setting to succeed. in_count The number of vertices on which to set the color. This value must be such that in_start+in_count<=point_count for the setting to succeed. in_rgb_color The RGB color to set on the vertices for this CylinderKey. in_apply_to The cylinder component the colors should apply to. Defaults to Cylinder.Component.Faces.
- Returns
- A reference to this CylinderKey.
|
inline |
Sets a single RGB color on a range of vertices starting at the specified offset which apply to the specified cylinder component.
- Parameters
-
in_start The offset into the vertices for this CylinderKey at which to start setting the color. This value must be such that in_start<point_count for setting to succeed. in_count The number of vertices on which to set the color. This value must be such that in_start+in_count<=point_count for the setting to succeed. in_rgb_color The RGB color to set on the vertices for this CylinderKey.
- Returns
- A reference to this CylinderKey.
|
inline |
Copy the contents of this CylinderKey into the specified kit.
- Parameters
-
out_kit The kit to populate with the contents of this CylinderKey.
|
inline |
Show the capping for this CylinderKey.
- Parameters
-
out_caps The capping for this CylinderKey.
- Returns
- true if a capping was set, false otherwise.
|
inline |
Show the points for this CylinderKey.
- Parameters
-
out_points The points for this CylinderKey.
- Returns
- true if points were set, false otherwise.
|
inline |
Show a subset of the points for this CylinderKey by list.
- Parameters
-
in_indices The list of point indices to show. out_points The requested points for this CylinderKey.
- Returns
- true if all requested points were set, false otherwise.
|
inline |
Show a subset of the points for this CylinderKey by range.
- Parameters
-
in_start_index The first point to show. in_count The number of points to show. out_points The requested points for this CylinderKey.
- Returns
- true if all requested points were set, false otherwise.
|
inline |
Show the radii for this CylinderKey.
- Parameters
-
out_radii The radii for this CylinderKey.
- Returns
- true if radii were set, false otherwise.
|
inline |
Shows all the vertex colors of the specified cylinder component.
- Parameters
-
in_apply_to The cylinder component the colors should apply to. out_types The types of vertex colors for each vertex. If a vertex does not have a vertex color set for the specified cylinder component, the entry in this array will be Material.Type.None. out_rgb_colors The RGB colors for each vertex. out_rgb_colors[i] is only valid if out_types[i] is Material.Type.RGBColor. out_indices The material indices for each vertex. The out_indices[i] is only valid if out_types[i] is Material.Type.MaterialIndex.
- Returns
- true if any vertex colors were shown, false otherwise.
|
inline |
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_vertices The indices of the vertices on which to show the colors. in_apply_to The cylinder component the colors should apply to. out_types The types of vertex colors for each vertex at the specified index. If a vertex at a specified index does not have a vertex color set for the specified component, the entry in this array will be Material.Type.None. out_rgb_colors The RGB colors for each vertex at the specified index. out_rgb_colors[i] is only valid if out_types[i] is Material.Type.RGBColor. out_indices The material indices for each vertex at the specified index. The out_indices[i] is only valid if out_types[i] is Material.Type.MaterialIndex.
- Returns
- true if any specified vertex had a vertex color on the specified component set, false otherwise.
|
inline |
Shows the vertex colors on a range of vertices starting at the specified offset which apply to the specified cylinder component.
- Parameters
-
in_start The offset into the vertices for this CylinderKey at which to start showing colors. This value must be such that in_start<point_count for showing to succeed. in_count The number of colors to show. This value must be such that in_start+in_count<=point_count for showing to succeed. in_apply_to The cylinder component the colors should apply to. out_types The types of vertex colors for each vertex in the specified range. If a vertex in the specified range does not have a vertex color set for the specified cylinder component, the entry in this array will be Material.Type.None. out_rgb_colors The RGB colors for each vertex in the specified range. out_rgb_colors[i] is only valid if out_types[i] is Material.Type.RGBColor. out_indices The material indices for each vertex in the specified range. The out_indices[i] is only valid if out_types[i] is Material.Type.MaterialIndex.
- Returns
- true if any vertex in the specified range had a vertex color on the specified component set, false otherwise.
|
inline |
Removes all vertex colors (RGB colors or material indices) for all cylinder components.
- Returns
- A reference to this CylinderKey.
|
inline |
Removes all vertex colors (RGB colors or material indices) for the specified cylinder component.
- Parameters
-
in_apply_to The cylinder component for which to remove the colors.
- Returns
- A reference to this CylinderKey.
|
inline |
Removes the vertex visibilities on a selection of arbitrary vertices.
- Parameters
-
in_vertices The indices of the vertices on which to remove the visibilities.
- Returns
- A reference to this CylinderKey.
|
inline |
Removes the vertex visibilities on a selection of arbitrary vertices.
- Parameters
-
in_vertices The indices of the vertices on which to remove the visibilities. in_apply_to The cylinder component that should be unset.
- Returns
- A reference to this CylinderKey.
|
inline |
Removes the specified range of vertex colors (RGB colors or material indices) for all cylinder components starting at the specified offset.
- Parameters
-
in_start The offset into the vertices for this CylinderKey at which to start removing colors. This value must be such that in_start<point_count for unsetting to succeed. in_count The number of vertex colors to remove for this CylinderKey. This value must be such that in_start+in_count<=point_count for unsetting to succeed.
- Returns
- A reference to this CylinderKey.
|
inline |
Removes the specified range of vertex colors (RGB colors or material indices) for the specified cylinder component starting at the specified offset.
- Parameters
-
in_start The offset into the vertices for this CylinderKey at which to start removing colors. This value must be such that in_start<point_count for unsetting to succeed. in_count The number of vertex colors to remove for this CylinderKey. This value must be such that in_start+in_count<=point_count for unsetting to succeed. in_apply_to The 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:
- internals/hps_core/source/cs/HPS.CylinderKey.cs