Inheritance diagram for HPS.CuttingSectionKit:
HPS.Kit HPS.Object

Public Member Functions

void Consume (HPS.CuttingSectionKit in_kit)
 
 CuttingSectionKit ()
 
 CuttingSectionKit (HPS.CuttingSectionKit in_kit)
 
override void Dispose ()
 
HPS.CuttingSectionKit EditPlanesByDeletion (ulong in_offset, ulong in_count)
 
HPS.CuttingSectionKit EditPlanesByInsertion (ulong in_offset, HPS.Plane[] in_planes)
 
HPS.CuttingSectionKit EditPlanesByReplacement (ulong in_offset, HPS.Plane[] in_planes)
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.CuttingSectionKit in_kit)
 
override int GetHashCode ()
 
ulong GetPlaneCount ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.CuttingSectionKit in_kit)
 
HPS.CuttingSectionKit SetPlanes (HPS.Plane in_plane)
 
HPS.CuttingSectionKit SetPlanes (HPS.Plane[] in_planes)
 
HPS.CuttingSectionKit SetPriority (int in_priority)
 
HPS.CuttingSectionKit SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)
 
HPS.CuttingSectionKit SetUserData (IntPtr in_index, byte[] in_data)
 
HPS.CuttingSectionKit SetUserData (IntPtr[] in_indices, byte[][] in_data)
 
HPS.CuttingSectionKit SetVisualization (HPS.CuttingSection.Mode in_mode, HPS.RGBAColor in_color, float in_scale)
 
HPS.CuttingSectionKit SetVisualization (HPS.CuttingSection.Mode in_mode, HPS.RGBAColor in_color)
 
void Show (out HPS.CuttingSectionKit out_kit)
 
bool ShowPlanes (out HPS.Plane[] out_planes)
 
bool ShowPriority (out int out_priority)
 
bool ShowUserData (IntPtr in_index, out byte[] out_data)
 
bool ShowUserData (out IntPtr[] out_indices, out byte[][] out_data)
 
ulong ShowUserDataCount ()
 
bool ShowUserDataIndices (out IntPtr[] out_indices)
 
bool ShowVisualization (out HPS.CuttingSection.Mode out_mode, out HPS.RGBAColor out_color, out float out_scale)
 
HPS.CuttingSectionKit UnsetAllUserData ()
 
HPS.CuttingSectionKit UnsetEverything ()
 
HPS.CuttingSectionKit UnsetPlanes ()
 
HPS.CuttingSectionKit UnsetPriority ()
 
HPS.CuttingSectionKit UnsetUserData (IntPtr in_index)
 
HPS.CuttingSectionKit UnsetUserData (IntPtr[] in_indices)
 
HPS.CuttingSectionKit UnsetVisualization ()
 
- Public Member Functions inherited from HPS.Kit
override void Dispose ()
 
 Kit (HPS.Kit in_that)
 
override HPS.Type ObjectType ()
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static bool operator!= (HPS.CuttingSectionKit a, HPS.CuttingSectionKit b)
 
static bool operator== (HPS.CuttingSectionKit a, HPS.CuttingSectionKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

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

Constructor & Destructor Documentation

◆ CuttingSectionKit() [1/2]

HPS.CuttingSectionKit.CuttingSectionKit ( )
inline

The default constructor creates an empty CuttingSectionKit object.

◆ CuttingSectionKit() [2/2]

HPS.CuttingSectionKit.CuttingSectionKit ( HPS.CuttingSectionKit  in_kit)
inline

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

Parameters
in_kitThe source CuttingSectionKit to copy.

Member Function Documentation

◆ Consume()

void HPS.CuttingSectionKit.Consume ( HPS.CuttingSectionKit  in_kit)
inline

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

Parameters
in_kitThe source CuttingSectionKit to consume.

◆ EditPlanesByDeletion()

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

Removes planes from the cutting plane list for this CuttingSectionKit.

Parameters
in_offsetThe 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.
in_countThe 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.
Returns
A reference to this CuttingSectionKit.

◆ EditPlanesByInsertion()

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

Adds cutting planes to this CuttingSectionKit.

Parameters
in_offsetThe 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.
in_planesThe planes to insert into the cutting plane list at the specified offset.
Returns
A reference to this CuttingSectionKit.

◆ EditPlanesByReplacement()

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

Replaces planes in the cutting plane list for this CuttingSectionKit.

Parameters
in_offsetThe 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.
in_planesThe 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.
Returns
A reference to this CuttingSectionKit.

◆ Empty()

override bool HPS.CuttingSectionKit.Empty ( )
inlinevirtual

Indicates whether this CuttingSectionKit has any values set on it.

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

Reimplemented from HPS.Object.

◆ Equals()

bool HPS.CuttingSectionKit.Equals ( HPS.CuttingSectionKit  in_kit)
inline

Check if the source CuttingSectionKit is equivalent to this CuttingSectionKit.

Parameters
in_kitThe source CuttingSectionKit to compare to this CuttingSectionKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetPlaneCount()

ulong HPS.CuttingSectionKit.GetPlaneCount ( )
inline

Gets the number of cutting planes for this CuttingSectionKit.

Returns
The number of cutting planes for this CuttingSectionKit.

◆ ObjectType()

override HPS.Type HPS.CuttingSectionKit.ObjectType ( )
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.

◆ Set()

void HPS.CuttingSectionKit.Set ( HPS.CuttingSectionKit  in_kit)
inline

Copies the source CuttingSectionKit into this CuttingSectionKit.

Parameters
in_kitThe source CuttingSectionKit to copy.

◆ SetPlanes() [1/2]

HPS.CuttingSectionKit HPS.CuttingSectionKit.SetPlanes ( HPS.Plane  in_plane)
inline

Sets a single cutting plane for this CuttingSectionKit.

Parameters
in_planeThe cutting plane for this CuttingSectionKit.
Returns
A reference to this CuttingSectionKit.

◆ SetPlanes() [2/2]

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

Sets multiple cutting planes for this CuttingSectionKit.

Parameters
in_planesThe cutting planes for this CuttingSectionKit.
Returns
A reference to this CuttingSectionKit.

◆ SetPriority()

HPS.CuttingSectionKit HPS.CuttingSectionKit.SetPriority ( int  in_priority)
inline

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.

Parameters
in_priorityThe drawing priority, higher priority items are drawn on top of lower priority items.
Returns
A reference to this object.
See also
SubwindowKit.SetPriority()
SubwindowKit.SetRenderingAlgorithm()

◆ SetUserData() [1/3]

HPS.CuttingSectionKit HPS.CuttingSectionKit.SetUserData ( IntPtr  in_index,
ulong  in_bytes,
byte []  in_data 
)
inline

Sets user data on this kit.

Parameters
in_indexThe index of the user data to set.
in_bytesThe number of bytes of user data to set.
in_dataThe bytes of user data to set.
Returns
A reference to this kit.

◆ SetUserData() [2/3]

HPS.CuttingSectionKit HPS.CuttingSectionKit.SetUserData ( IntPtr  in_index,
byte []  in_data 
)
inline

Sets user data on this kit.

Parameters
in_indexThe index of the user data to set.
in_dataThe bytes of user data to set.
Returns
A reference to this kit.

◆ SetUserData() [3/3]

HPS.CuttingSectionKit HPS.CuttingSectionKit.SetUserData ( IntPtr []  in_indices,
byte  in_data[][] 
)
inline

Sets user data on this kit.

Parameters
in_indicesAn array of user data indices to set.
in_dataAn array of bytes of user data to set.
Returns
A reference to this kit.

◆ SetVisualization() [1/2]

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

Sets visualization to use for this CuttingSectionKit.

Parameters
in_modeThe mode for the CuttingSectionKit.
in_colorThe RGBA color for the CuttingSectionKit.
in_scaleThe scale to apply to the visualization geometry for this CuttingSectionKit. Defaults to 1.0f.
Returns
A reference to this CuttingSectionKit.

◆ SetVisualization() [2/2]

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

Sets visualization to use for this CuttingSectionKit.

Parameters
in_modeThe mode for the CuttingSectionKit.
in_colorThe RGBA color for the CuttingSectionKit.
Returns
A reference to this CuttingSectionKit.

◆ Show()

void HPS.CuttingSectionKit.Show ( out HPS.CuttingSectionKit  out_kit)
inline

Copies this CuttingSectionKit into the given CuttingSectionKit.

Parameters
out_kitThe CuttingSectionKit to populate with the contents of this CuttingSectionKit.

◆ ShowPlanes()

bool HPS.CuttingSectionKit.ShowPlanes ( out HPS.Plane []  out_planes)
inline

Shows the cutting planes for this CuttingSectionKit.

Parameters
out_planesThe cutting planes for this CuttingSectionKit.
Returns
true if any cutting planes were set, false otherwise.

◆ ShowPriority()

bool HPS.CuttingSectionKit.ShowPriority ( out int  out_priority)
inline

Shows the drawing priority.

Parameters
out_priorityThe drawing priority, higher priority items are drawn on top of lower priority items.
Returns
true if the setting is valid, false otherwise.

◆ ShowUserData() [1/2]

bool HPS.CuttingSectionKit.ShowUserData ( IntPtr  in_index,
out byte []  out_data 
)
inline

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

Parameters
in_indexThe index of the user data to show.
out_dataThe user data at the given index.
Returns
true if there is user data at the given index, false otherwise.

◆ ShowUserData() [2/2]

bool HPS.CuttingSectionKit.ShowUserData ( out IntPtr []  out_indices,
out byte  out_data[][] 
)
inline

Shows all user data for this kit.

Parameters
out_indicesAn array of all user data indices set on this kit.
out_dataAn array of all user data set on this kit.
Returns
true if there is user data on this kit, false otherwise.

◆ ShowUserDataCount()

ulong HPS.CuttingSectionKit.ShowUserDataCount ( )
inline

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

◆ ShowUserDataIndices()

bool HPS.CuttingSectionKit.ShowUserDataIndices ( out IntPtr []  out_indices)
inline

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

Parameters
out_indicesThe user data indices set on this kit.
Returns
The number of user data indices set on this kit.

◆ ShowVisualization()

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

Shows the visualization to use for this CuttingSectionKit.

Parameters
out_modeThe mode for this CuttingSectionKit.
out_colorThe RGBA color for this CuttingSectionKit.
out_scaleThe scale to apply to the visualization geometry for this CuttingSectionKit.
Returns
true if visualization options were set, false otherwise.

◆ UnsetAllUserData()

HPS.CuttingSectionKit HPS.CuttingSectionKit.UnsetAllUserData ( )
inline

Removes all user data from this kit.

Returns
A reference to this kit.

◆ UnsetEverything()

HPS.CuttingSectionKit HPS.CuttingSectionKit.UnsetEverything ( )
inline

Removes all settings from the CuttingSectionKit.

Returns
A reference to this CuttingSectionKit.

◆ UnsetPlanes()

HPS.CuttingSectionKit HPS.CuttingSectionKit.UnsetPlanes ( )
inline

Removes the cutting planes for this CuttingSectionKit.

Returns
A reference to this CuttingSectionKit.

◆ UnsetPriority()

HPS.CuttingSectionKit HPS.CuttingSectionKit.UnsetPriority ( )
inline

Removes a drawing priority setting.

Returns
A reference to this object.

◆ UnsetUserData() [1/2]

HPS.CuttingSectionKit HPS.CuttingSectionKit.UnsetUserData ( IntPtr  in_index)
inline

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

Parameters
in_indexThe index of the user data to remove.
Returns
A reference to this kit.

◆ UnsetUserData() [2/2]

HPS.CuttingSectionKit HPS.CuttingSectionKit.UnsetUserData ( IntPtr []  in_indices)
inline

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

Parameters
in_indicesThe indices of the user data to remove.
Returns
A reference to this kit.

◆ UnsetVisualization()

HPS.CuttingSectionKit HPS.CuttingSectionKit.UnsetVisualization ( )
inline

Removes the visualization settings for this CuttingSectionKit.

Returns
A reference to this CuttingSectionKit.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.CuttingSectionKit.cs