HPS::CuttingSectionKit Class Reference

#include <hps.h>

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

Public Member Functions

void Consume (CuttingSectionKit &in_kit)
 
 CuttingSectionKit ()
 
 CuttingSectionKit (CuttingSectionKit const &in_kit)
 
 CuttingSectionKit (CuttingSectionKit &&in_that)
 
CuttingSectionKitEditPlanesByDeletion (size_t in_offset, size_t in_count)
 
CuttingSectionKitEditPlanesByInsertion (size_t in_offset, size_t in_count, Plane const in_planes[])
 
CuttingSectionKitEditPlanesByInsertion (size_t in_offset, PlaneArray const &in_planes)
 
CuttingSectionKitEditPlanesByReplacement (size_t in_offset, size_t in_count, Plane const in_planes[])
 
CuttingSectionKitEditPlanesByReplacement (size_t in_offset, PlaneArray const &in_planes)
 
bool Empty () const
 
bool Equals (CuttingSectionKit const &in_kit) const
 
size_t GetPlaneCount () const
 
HPS::Type ObjectType () const
 
bool operator!= (CuttingSectionKit const &in_kit) const
 
CuttingSectionKitoperator= (CuttingSectionKit &&in_that)
 
CuttingSectionKitoperator= (CuttingSectionKit const &in_kit)
 
bool operator== (CuttingSectionKit const &in_kit) const
 
void Set (CuttingSectionKit const &in_kit)
 
CuttingSectionKitSetPlanes (Plane const &in_plane)
 
CuttingSectionKitSetPlanes (PlaneArray const &in_planes)
 
CuttingSectionKitSetPlanes (size_t in_count, Plane const in_planes[])
 
CuttingSectionKitSetPriority (int in_priority)
 
CuttingSectionKitSetUserData (intptr_t in_index, size_t in_bytes, byte const in_data[])
 
CuttingSectionKitSetUserData (intptr_t in_index, ByteArray const &in_data)
 
CuttingSectionKitSetUserData (IntPtrTArray const &in_indices, ByteArrayArray const &in_data)
 
CuttingSectionKitSetVisualization (CuttingSection::Mode in_mode, RGBAColor const &in_color, float in_scale=1.0f)
 
void Show (CuttingSectionKit &out_kit) const
 
bool ShowPlanes (HPS::PlaneArray &out_planes) const
 
bool ShowPriority (int &out_priority) const
 
bool ShowUserData (intptr_t in_index, ByteArray &out_data) const
 
bool ShowUserData (IntPtrTArray &out_indices, ByteArrayArray &out_data) const
 
size_t ShowUserDataCount () const
 
bool ShowUserDataIndices (IntPtrTArray &out_indices) const
 
bool ShowVisualization (CuttingSection::Mode &out_mode, RGBAColor &out_color, float &out_scale) const
 
CuttingSectionKitUnsetAllUserData ()
 
CuttingSectionKitUnsetEverything ()
 
CuttingSectionKitUnsetPlanes ()
 
CuttingSectionKitUnsetPriority ()
 
CuttingSectionKitUnsetUserData (intptr_t in_index)
 
CuttingSectionKitUnsetUserData (size_t in_count, intptr_t const in_indices[])
 
CuttingSectionKitUnsetUserData (IntPtrTArray const &in_indices)
 
CuttingSectionKitUnsetVisualization ()
 
- Public Member Functions inherited from HPS::Kit
virtual HPS::Type Type () const
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::CuttingSectionKit
 
- Static Public Attributes inherited from HPS::Kit
static const HPS::Type staticType = HPS::Type::Kit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (Kit &&in_that)
 

Detailed Description

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

Constructor & Destructor Documentation

◆ CuttingSectionKit() [1/3]

HPS::CuttingSectionKit::CuttingSectionKit ( )

The default constructor creates an empty CuttingSectionKit object.

◆ CuttingSectionKit() [2/3]

HPS::CuttingSectionKit::CuttingSectionKit ( CuttingSectionKit const &  in_kit)

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

Parameters
in_kitThe source CuttingSectionKit to copy.

◆ CuttingSectionKit() [3/3]

HPS::CuttingSectionKit::CuttingSectionKit ( CuttingSectionKit &&  in_that)

The move constructor creates a CuttingSectionKit by transferring the underlying impl of the rvalue reference to this CuttingSectionKit thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to a CuttingSectionKit to take the impl from.

Member Function Documentation

◆ Consume()

void HPS::CuttingSectionKit::Consume ( CuttingSectionKit in_kit)

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

Parameters
in_kitThe source CuttingSectionKit to consume.

◆ EditPlanesByDeletion()

CuttingSectionKit& HPS::CuttingSectionKit::EditPlanesByDeletion ( size_t  in_offset,
size_t  in_count 
)

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() [1/2]

CuttingSectionKit& HPS::CuttingSectionKit::EditPlanesByInsertion ( size_t  in_offset,
size_t  in_count,
Plane const  in_planes[] 
)

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

◆ EditPlanesByInsertion() [2/2]

CuttingSectionKit& HPS::CuttingSectionKit::EditPlanesByInsertion ( size_t  in_offset,
PlaneArray const &  in_planes 
)

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() [1/2]

CuttingSectionKit& HPS::CuttingSectionKit::EditPlanesByReplacement ( size_t  in_offset,
size_t  in_count,
Plane const  in_planes[] 
)

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_countSize of the following array. This value must be such that in_offset+in_count<=cutting_plane_count for the replacement to succeed.
in_planesThe planes to use to replace those in the cutting plane list at the specified offset.
Returns
A reference to this CuttingSectionKit.

◆ EditPlanesByReplacement() [2/2]

CuttingSectionKit& HPS::CuttingSectionKit::EditPlanesByReplacement ( size_t  in_offset,
PlaneArray const &  in_planes 
)

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_countSize of the following array. This value must be such that in_offset+in_count<=cutting_plane_count for the 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()

bool HPS::CuttingSectionKit::Empty ( ) const
virtual

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 ( CuttingSectionKit const &  in_kit) const

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

size_t HPS::CuttingSectionKit::GetPlaneCount ( ) const

Gets the number of cutting planes for this CuttingSectionKit.

Returns
The number of cutting planes for this CuttingSectionKit.

◆ ObjectType()

HPS::Type HPS::CuttingSectionKit::ObjectType ( ) const
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::Kit.

◆ operator!=()

bool HPS::CuttingSectionKit::operator!= ( CuttingSectionKit const &  in_kit) const

Check if the source CuttingSectionKit is not equivalent to this CuttingSectionKit.

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

◆ operator=() [1/2]

CuttingSectionKit& HPS::CuttingSectionKit::operator= ( CuttingSectionKit &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this CuttingSectionKit thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to a CuttingSectionKit to take the impl from.
Returns
A reference to this CuttingSectionKit.

◆ operator=() [2/2]

CuttingSectionKit& HPS::CuttingSectionKit::operator= ( CuttingSectionKit const &  in_kit)

Copies the source CuttingSectionKit into this CuttingSectionKit.

Parameters
in_kitThe source CuttingSectionKit to copy.
Returns
A reference to this CuttingSectionKit.

◆ operator==()

bool HPS::CuttingSectionKit::operator== ( CuttingSectionKit const &  in_kit) const

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.

◆ Set()

void HPS::CuttingSectionKit::Set ( CuttingSectionKit const &  in_kit)

Copies the source CuttingSectionKit into this CuttingSectionKit.

Parameters
in_kitThe source CuttingSectionKit to copy.

◆ SetPlanes() [1/3]

CuttingSectionKit& HPS::CuttingSectionKit::SetPlanes ( Plane const &  in_plane)

Sets a single cutting plane for this CuttingSectionKit.

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

◆ SetPlanes() [2/3]

CuttingSectionKit& HPS::CuttingSectionKit::SetPlanes ( PlaneArray const &  in_planes)

Sets multiple cutting planes for this CuttingSectionKit.

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

◆ SetPlanes() [3/3]

CuttingSectionKit& HPS::CuttingSectionKit::SetPlanes ( size_t  in_count,
Plane const  in_planes[] 
)

Sets multiple cutting planes for this CuttingSectionKit.

Parameters
in_countSize of the following array.
in_planesThe cutting planes for this CuttingSectionKit.
Returns
A reference to this CuttingSectionKit.

◆ SetPriority()

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.

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]

CuttingSectionKit& HPS::CuttingSectionKit::SetUserData ( intptr_t  in_index,
size_t  in_bytes,
byte const  in_data[] 
)

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]

CuttingSectionKit& HPS::CuttingSectionKit::SetUserData ( intptr_t  in_index,
ByteArray const &  in_data 
)

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]

CuttingSectionKit& HPS::CuttingSectionKit::SetUserData ( IntPtrTArray const &  in_indices,
ByteArrayArray const &  in_data 
)

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

CuttingSectionKit& HPS::CuttingSectionKit::SetVisualization ( CuttingSection::Mode  in_mode,
RGBAColor const &  in_color,
float  in_scale = 1.0f 
)

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.

◆ Show()

void HPS::CuttingSectionKit::Show ( CuttingSectionKit out_kit) const

Copies this CuttingSectionKit into the given CuttingSectionKit.

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

◆ ShowPlanes()

bool HPS::CuttingSectionKit::ShowPlanes ( HPS::PlaneArray out_planes) const

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 ( int &  out_priority) const

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_t  in_index,
ByteArray out_data 
) const

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 ( IntPtrTArray out_indices,
ByteArrayArray out_data 
) const

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

size_t HPS::CuttingSectionKit::ShowUserDataCount ( ) const

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

◆ ShowUserDataIndices()

bool HPS::CuttingSectionKit::ShowUserDataIndices ( IntPtrTArray out_indices) const

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 ( CuttingSection::Mode out_mode,
RGBAColor out_color,
float &  out_scale 
) const

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

CuttingSectionKit& HPS::CuttingSectionKit::UnsetAllUserData ( )

Removes all user data from this kit.

Returns
A reference to this kit.

◆ UnsetEverything()

CuttingSectionKit& HPS::CuttingSectionKit::UnsetEverything ( )

Removes all settings from the CuttingSectionKit.

Returns
A reference to this CuttingSectionKit.

◆ UnsetPlanes()

CuttingSectionKit& HPS::CuttingSectionKit::UnsetPlanes ( )

Removes the cutting planes for this CuttingSectionKit.

Returns
A reference to this CuttingSectionKit.

◆ UnsetPriority()

CuttingSectionKit& HPS::CuttingSectionKit::UnsetPriority ( )

Removes a drawing priority setting.

Returns
A reference to this object.

◆ UnsetUserData() [1/3]

CuttingSectionKit& HPS::CuttingSectionKit::UnsetUserData ( intptr_t  in_index)

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/3]

CuttingSectionKit& HPS::CuttingSectionKit::UnsetUserData ( size_t  in_count,
intptr_t const  in_indices[] 
)

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

Parameters
in_countThe size of the following array.
in_indicesThe indices of the user data to remove.
Returns
A reference to this kit.

◆ UnsetUserData() [3/3]

CuttingSectionKit& HPS::CuttingSectionKit::UnsetUserData ( IntPtrTArray const &  in_indices)

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

CuttingSectionKit& HPS::CuttingSectionKit::UnsetVisualization ( )

Removes the visualization settings for this CuttingSectionKit.

Returns
A reference to this CuttingSectionKit.

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