CuttingSectionKit

class HPS.CuttingSectionKit : public HPS.Kit 

The CuttingSectionKit class is a user space object. It is a kit analog to a CuttingSectionKey.

Public Functions

void Consume (HPS.CuttingSectionKit in_kit)

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

Param in_kit: The source CuttingSectionKit to consume.

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

CuttingSectionKit (HPS.CuttingSectionKit in_kit)

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

Param in_kit: The source CuttingSectionKit to copy.

override void Dispose ()

HPS.CuttingSectionKit EditPlanesByDeletion (ulong in_offset, ulong in_count)

Removes planes from the cutting plane list for this CuttingSectionKit.

Param in_offset: The offset into the cutting planes for this CuttingSectionKit at which to start removing planes. This value must be such that in_offset<cutting_plane_count for deletion to succeed.
Param in_count: The number of planes to remove from the cutting plane list for this CuttingSectionKit. This value must be such that in_offset+in_count<=cutting_plane_count for the deletion to succeed.
Return: A reference to this CuttingSectionKit.

HPS.CuttingSectionKit EditPlanesByInsertion (ulong in_offset, HPS.Plane[] in_planes)

Adds cutting planes to this CuttingSectionKit.

Param in_offset: The offset into the cutting plane list for the CuttingSectionKit at which to insert planes. This value must be such that in_offset<cutting_plane_count for insertion to succeed.
Param in_planes: The planes to insert into the cutting plane list at the specified offset.
Return: A reference to this CuttingSectionKit.

HPS.CuttingSectionKit EditPlanesByReplacement (ulong in_offset, HPS.Plane[] in_planes)

Replaces planes in the cutting plane list for this CuttingSectionKit.

Param in_offset: The offset into the cutting plane list for this CuttingSectionKit at which to start replacing planes. This value must be such that in_offset<cutting_plane_count for replacement to succeed.
Param in_planes: The planes to use to replace those in the cutting plane list at the specified offset. The size of this array must be such that in_offset+in_planes.size()<=cutting_plane_count for the replacement to succeed.
Return: A reference to this CuttingSectionKit.

override bool Empty ()

Indicates whether this CuttingSectionKit has any values set on it.

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

bool Equals (HPS.CuttingSectionKit in_kit)

Check if the source CuttingSectionKit is equivalent to this CuttingSectionKit.

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

override bool Equals (Object obj)

override int GetHashCode ()

ulong GetPlaneCount ()

Gets the number of cutting planes for this CuttingSectionKit.

Return: The number of cutting planes for this CuttingSectionKit.

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.CuttingSectionKit in_kit)

Copies the source CuttingSectionKit into this CuttingSectionKit.

Param in_kit: The source CuttingSectionKit to copy.

HPS.CuttingSectionKit SetPlanes (HPS.Plane in_plane)

Sets a single cutting plane for this CuttingSectionKit.

Param in_plane: The cutting plane for this CuttingSectionKit.
Return: A reference to this CuttingSectionKit.

HPS.CuttingSectionKit SetPlanes (HPS.Plane[] in_planes)

Sets multiple cutting planes for this CuttingSectionKit.

Param in_planes: The cutting planes for this CuttingSectionKit.
Return: A reference to this CuttingSectionKit.

HPS.CuttingSectionKit SetPriority (int in_priority)

Assigns a specific drawing priority value to the CuttingSectionKit. 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: SubwindowKit.SetPriority()
See: SubwindowKit.SetRenderingAlgorithm()

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

HPS.CuttingSectionKit 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.CuttingSectionKit 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.CuttingSectionKit 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.CuttingSectionKit SetVisualization (HPS.CuttingSection.Mode in_mode, HPS.RGBAColor in_color)

Sets visualization to use for this CuttingSectionKit.

Param in_mode: The mode for the CuttingSectionKit.
Param in_color: The RGBA color for the CuttingSectionKit.
Return: A reference to this CuttingSectionKit.

HPS.CuttingSectionKit SetVisualization (HPS.CuttingSection.Mode in_mode, HPS.RGBAColor in_color, float in_scale)

Sets visualization to use for this CuttingSectionKit.

Param in_mode: The mode for the CuttingSectionKit.
Param in_color: The RGBA color for the CuttingSectionKit.
Param in_scale: The scale to apply to the visualization geometry for this CuttingSectionKit. Defaults to 1.0f.
Return: A reference to this CuttingSectionKit.

void Show (out HPS.CuttingSectionKit out_kit)

Copies this CuttingSectionKit into the given CuttingSectionKit.

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

bool ShowPlanes (out HPS.Plane[] out_planes)

Shows the cutting planes for this CuttingSectionKit.

Param out_planes: The cutting planes for this CuttingSectionKit.
Return: true if any cutting planes 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 ShowVisualization (out HPS.CuttingSection.Mode out_mode, out HPS.RGBAColor out_color, out float out_scale)

Shows the visualization to use for this CuttingSectionKit.

Param out_mode: The mode for this CuttingSectionKit.
Param out_color: The RGBA color for this CuttingSectionKit.
Param out_scale: The scale to apply to the visualization geometry for this CuttingSectionKit.
Return: true if visualization options were set, false otherwise.