#include <hps.h>
Public Member Functions | |
CuttingSectionKit () | |
CuttingSectionKit (CuttingSectionKit const &in_kit) | |
CuttingSectionKit (CuttingSectionKit &&in_that) | |
CuttingSectionKit & | operator= (CuttingSectionKit &&in_that) |
HPS::Type | ObjectType () const |
void | Consume (CuttingSectionKit &in_kit) |
void | Set (CuttingSectionKit const &in_kit) |
void | Show (CuttingSectionKit &out_kit) const |
CuttingSectionKit & | operator= (CuttingSectionKit const &in_kit) |
bool | Empty () const |
bool | Equals (CuttingSectionKit const &in_kit) const |
bool | operator== (CuttingSectionKit const &in_kit) const |
bool | operator!= (CuttingSectionKit const &in_kit) const |
CuttingSectionKit & | SetPriority (int in_priority) |
CuttingSectionKit & | UnsetPriority () |
bool | ShowPriority (int &out_priority) const |
CuttingSectionKit & | SetPlanes (Plane const &in_plane) |
CuttingSectionKit & | SetPlanes (PlaneArray const &in_planes) |
CuttingSectionKit & | SetPlanes (size_t in_count, Plane const in_planes[]) |
CuttingSectionKit & | SetVisualization (CuttingSection::Mode in_mode, RGBAColor const &in_color, float in_scale=1.0f) |
CuttingSectionKit & | UnsetPlanes () |
CuttingSectionKit & | UnsetVisualization () |
CuttingSectionKit & | UnsetEverything () |
size_t | GetPlaneCount () const |
bool | ShowPlanes (HPS::PlaneArray &out_planes) const |
bool | ShowVisualization (CuttingSection::Mode &out_mode, RGBAColor &out_color, float &out_scale) const |
CuttingSectionKit & | EditPlanesByInsertion (size_t in_offset, size_t in_count, Plane const in_planes[]) |
CuttingSectionKit & | EditPlanesByInsertion (size_t in_offset, PlaneArray const &in_planes) |
CuttingSectionKit & | EditPlanesByDeletion (size_t in_offset, size_t in_count) |
CuttingSectionKit & | EditPlanesByReplacement (size_t in_offset, size_t in_count, Plane const in_planes[]) |
CuttingSectionKit & | EditPlanesByReplacement (size_t in_offset, PlaneArray const &in_planes) |
CuttingSectionKit & | SetUserData (intptr_t in_index, size_t in_bytes, byte const in_data[]) |
CuttingSectionKit & | SetUserData (intptr_t in_index, ByteArray const &in_data) |
CuttingSectionKit & | SetUserData (IntPtrTArray const &in_indices, ByteArrayArray const &in_data) |
CuttingSectionKit & | UnsetUserData (intptr_t in_index) |
CuttingSectionKit & | UnsetUserData (size_t in_count, intptr_t const in_indices[]) |
CuttingSectionKit & | UnsetUserData (IntPtrTArray const &in_indices) |
CuttingSectionKit & | UnsetAllUserData () |
size_t | ShowUserDataCount () const |
bool | ShowUserDataIndices (IntPtrTArray &out_indices) const |
bool | ShowUserData (intptr_t in_index, ByteArray &out_data) const |
bool | ShowUserData (IntPtrTArray &out_indices, ByteArrayArray &out_data) const |
![]() | |
Object & | operator= (Object const &other_object) |
Object (Object &&in_that) | |
Object & | operator= (Object &&in_that) |
HPS::Type | Type () const |
virtual void | Reset () |
bool | HasType (HPS::Type in_mask) const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
The CuttingSectionKit class is a user space object. It is a kit analog to a CuttingSectionKey.
HPS::CuttingSectionKit::CuttingSectionKit | ( | ) |
The default constructor creates an empty CuttingSectionKit object.
HPS::CuttingSectionKit::CuttingSectionKit | ( | CuttingSectionKit const & | in_kit | ) |
The copy constructor creates a new CuttingSectionKit object that contains the same settings as the source CuttingSectionKit.
in_kit | The source CuttingSectionKit to copy. |
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.
in_that | An rvalue reference to a CuttingSectionKit to take the impl from. |
void HPS::CuttingSectionKit::Consume | ( | CuttingSectionKit & | in_kit | ) |
Copies the source CuttingSectionKit into this CuttingSectionKit and resets the source kit.
in_kit | The source CuttingSectionKit to consume. |
CuttingSectionKit& HPS::CuttingSectionKit::EditPlanesByDeletion | ( | size_t | in_offset, |
size_t | in_count | ||
) |
Removes planes from the cutting plane list for this CuttingSectionKit.
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. |
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. |
CuttingSectionKit& HPS::CuttingSectionKit::EditPlanesByInsertion | ( | size_t | in_offset, |
size_t | in_count, | ||
Plane const | in_planes[] | ||
) |
Adds cutting planes to this CuttingSectionKit.
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. |
in_count | Size of the following array. |
in_planes | The planes to insert into the cutting plane list at the specified offset. |
CuttingSectionKit& HPS::CuttingSectionKit::EditPlanesByInsertion | ( | size_t | in_offset, |
PlaneArray const & | in_planes | ||
) |
Adds cutting planes to this CuttingSectionKit.
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. |
in_planes | The planes to insert into the cutting plane list at the specified offset. |
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.
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. |
in_count | Size of the following array. This value must be such that in_offset+in_count<=cutting_plane_count for the replacement to succeed. |
in_planes | The planes to use to replace those in the cutting plane list at the specified offset. |
CuttingSectionKit& HPS::CuttingSectionKit::EditPlanesByReplacement | ( | size_t | in_offset, |
PlaneArray const & | in_planes | ||
) |
Replaces planes in the cutting plane list for this CuttingSectionKit.
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. |
in_count | Size of the following array. This value must be such that in_offset+in_count<=cutting_plane_count for the replacement to succeed. |
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. |
|
virtual |
Indicates whether this CuttingSectionKit has any values set on it.
Reimplemented from HPS::Object.
bool HPS::CuttingSectionKit::Equals | ( | CuttingSectionKit const & | in_kit | ) | const |
Check if the source CuttingSectionKit is equivalent to this CuttingSectionKit.
in_kit | The source CuttingSectionKit to compare to this CuttingSectionKit. |
size_t HPS::CuttingSectionKit::GetPlaneCount | ( | ) | const |
Gets the number of cutting planes for this CuttingSectionKit.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS::Object.
bool HPS::CuttingSectionKit::operator!= | ( | CuttingSectionKit const & | in_kit | ) | const |
Check if the source CuttingSectionKit is not equivalent to this CuttingSectionKit.
in_kit | The source CuttingSectionKit to compare to this CuttingSectionKit. |
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.
in_that | An rvalue reference to a CuttingSectionKit to take the impl from. |
CuttingSectionKit& HPS::CuttingSectionKit::operator= | ( | CuttingSectionKit const & | in_kit | ) |
Copies the source CuttingSectionKit into this CuttingSectionKit.
in_kit | The source CuttingSectionKit to copy. |
bool HPS::CuttingSectionKit::operator== | ( | CuttingSectionKit const & | in_kit | ) | const |
Check if the source CuttingSectionKit is equivalent to this CuttingSectionKit.
in_kit | The source CuttingSectionKit to compare to this CuttingSectionKit. |
void HPS::CuttingSectionKit::Set | ( | CuttingSectionKit const & | in_kit | ) |
Copies the source CuttingSectionKit into this CuttingSectionKit.
in_kit | The source CuttingSectionKit to copy. |
CuttingSectionKit& HPS::CuttingSectionKit::SetPlanes | ( | Plane const & | in_plane | ) |
Sets a single cutting plane for this CuttingSectionKit.
in_plane | The cutting plane for this CuttingSectionKit. |
CuttingSectionKit& HPS::CuttingSectionKit::SetPlanes | ( | PlaneArray const & | in_planes | ) |
Sets multiple cutting planes for this CuttingSectionKit.
in_planes | The cutting planes for this CuttingSectionKit. |
CuttingSectionKit& HPS::CuttingSectionKit::SetPlanes | ( | size_t | in_count, |
Plane const | in_planes[] | ||
) |
Sets multiple cutting planes for this CuttingSectionKit.
in_count | Size of the following array. |
in_planes | The cutting planes for this CuttingSectionKit. |
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.
in_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
CuttingSectionKit& HPS::CuttingSectionKit::SetUserData | ( | intptr_t | in_index, |
size_t | in_bytes, | ||
byte const | in_data[] | ||
) |
Sets user data on this kit.
in_index | The index of the user data to set. |
in_bytes | The number of bytes of user data to set. |
in_data | The bytes of user data to set. |
CuttingSectionKit& HPS::CuttingSectionKit::SetUserData | ( | intptr_t | in_index, |
ByteArray const & | in_data | ||
) |
Sets user data on this kit.
in_index | The index of the user data to set. |
in_data | The bytes of user data to set. |
CuttingSectionKit& HPS::CuttingSectionKit::SetUserData | ( | IntPtrTArray const & | in_indices, |
ByteArrayArray const & | in_data | ||
) |
Sets user data on this kit.
in_indices | An array of user data indices to set. |
in_data | An array of bytes of user data to set. |
CuttingSectionKit& HPS::CuttingSectionKit::SetVisualization | ( | CuttingSection::Mode | in_mode, |
RGBAColor const & | in_color, | ||
float | in_scale = 1.0f |
||
) |
Sets visualization to use for this CuttingSectionKit.
in_mode | The mode for the CuttingSectionKit. |
in_color | The RGBA color for the CuttingSectionKit. |
in_scale | The scale to apply to the visualization geometry for this CuttingSectionKit. Defaults to 1.0f. |
void HPS::CuttingSectionKit::Show | ( | CuttingSectionKit & | out_kit | ) | const |
Copies this CuttingSectionKit into the given CuttingSectionKit.
out_kit | The CuttingSectionKit to populate with the contents of this CuttingSectionKit. |
bool HPS::CuttingSectionKit::ShowPlanes | ( | HPS::PlaneArray & | out_planes | ) | const |
Shows the cutting planes for this CuttingSectionKit.
out_planes | The cutting planes for this CuttingSectionKit. |
bool HPS::CuttingSectionKit::ShowPriority | ( | int & | out_priority | ) | const |
Shows the drawing priority.
out_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
bool HPS::CuttingSectionKit::ShowUserData | ( | intptr_t | in_index, |
ByteArray & | out_data | ||
) | const |
Shows the user data at a given index for this kit.
in_index | The index of the user data to show. |
out_data | The user data at the given index. |
bool HPS::CuttingSectionKit::ShowUserData | ( | IntPtrTArray & | out_indices, |
ByteArrayArray & | out_data | ||
) | const |
Shows all user data for this kit.
out_indices | An array of all user data indices set on this kit. |
out_data | An array of all user data set on this kit. |
size_t HPS::CuttingSectionKit::ShowUserDataCount | ( | ) | const |
Get the number of user data indices set on this kit.
bool HPS::CuttingSectionKit::ShowUserDataIndices | ( | IntPtrTArray & | out_indices | ) | const |
Shows the indices of all user data set on this kit.
out_indices | The user data indices set on this kit. |
bool HPS::CuttingSectionKit::ShowVisualization | ( | CuttingSection::Mode & | out_mode, |
RGBAColor & | out_color, | ||
float & | out_scale | ||
) | const |
Shows the visualization to use for this CuttingSectionKit.
out_mode | The mode for this CuttingSectionKit. |
out_color | The RGBA color for this CuttingSectionKit. |
out_scale | The scale to apply to the visualization geometry for this CuttingSectionKit. |
CuttingSectionKit& HPS::CuttingSectionKit::UnsetAllUserData | ( | ) |
Removes all user data from this kit.
CuttingSectionKit& HPS::CuttingSectionKit::UnsetEverything | ( | ) |
Removes all settings from the CuttingSectionKit.
CuttingSectionKit& HPS::CuttingSectionKit::UnsetPlanes | ( | ) |
Removes the cutting planes for this CuttingSectionKit.
CuttingSectionKit& HPS::CuttingSectionKit::UnsetPriority | ( | ) |
Removes a drawing priority setting.
CuttingSectionKit& HPS::CuttingSectionKit::UnsetUserData | ( | intptr_t | in_index | ) |
Removes the user data at the given index from this kit.
in_index | The index of the user data to remove. |
CuttingSectionKit& HPS::CuttingSectionKit::UnsetUserData | ( | size_t | in_count, |
intptr_t const | in_indices[] | ||
) |
Removes the user data at the given indices from this kit.
in_count | The size of the following array. |
in_indices | The indices of the user data to remove. |
CuttingSectionKit& HPS::CuttingSectionKit::UnsetUserData | ( | IntPtrTArray const & | in_indices | ) |
Removes the user data at the given indices from this kit.
in_indices | The indices of the user data to remove. |
CuttingSectionKit& HPS::CuttingSectionKit::UnsetVisualization | ( | ) |
Removes the visualization settings for this CuttingSectionKit.