CuttingSectionKey

class HPS.CuttingSectionKey : HPS.GeometryKey 

The CuttingSectionKey class is a smart pointer to a database object. It is a handle to a cutting section inserted via SegmentKey.InsertCuttingSection.

Public Functions

void Consume (HPS.CuttingSectionKit in_kit)

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

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

CuttingSectionKey (HPS.CuttingSectionKey in_that)

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

Param in_that:	The source CuttingSectionKey to copy.

CuttingSectionKey (HPS.Key in_that)

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

Param in_that:	The source Key to copy.

override void Dispose ()

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

Removes planes from the cutting plane list for this CuttingSectionKey.

Param in_offset:
	The offset into the cutting planes for this CuttingSectionKey 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 CuttingSectionKey. This value must be such that in_offset+in_count<=cutting_plane_count for the deletion to succeed.
Return:	A reference to this CuttingSectionKey.

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

Adds cutting planes to this CuttingSectionKey.

Param in_offset:
	The offset into the cutting plane list for the CuttingSectionKey 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 CuttingSectionKey.

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

Replaces planes in the cutting plane list for this CuttingSectionKey.

Param in_offset:
	The offset into the cutting plane list for this CuttingSectionKey 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 CuttingSectionKey.

ulong GetPlaneCount ()

Gets the number of cutting planes for this CuttingSectionKey.

Return:	The number of cutting planes for this CuttingSectionKey.

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

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

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

HPS.CuttingSectionKey SetPlanes (HPS.Plane in_plane)

Sets a single cutting plane for this CuttingSectionKey.

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

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

Sets multiple cutting planes for this CuttingSectionKey.

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

HPS.CuttingSectionKey SetVisualization (HPS.CuttingSection.Mode in_mode, HPS.RGBAColor in_color)

Sets visualization to use for this CuttingSectionKey.

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

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

Sets visualization to use for this CuttingSectionKey.

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

void Show (out HPS.CuttingSectionKit out_kit)

Copy the contents of this CuttingSectionKey into the specified kit.

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

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

Shows the cutting planes for this CuttingSectionKey.

Param out_planes:
	The cutting planes for this CuttingSectionKey.
Return:	true if any cutting planes were set, false otherwise.

bool ShowVisualization (out HPS.CuttingSection.Mode out_mode, out HPS.RGBAColor out_color, out float out_scale)

Shows the visualization to use for this CuttingSectionKey.

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

CuttingSectionKey

Hello! I'm HOOPSY