REFERENCE MANUAL
#include <hps.h>
Public Member Functions | |
void | Consume (CuttingSectionKit &in_kit) |
CuttingSectionKey () | |
CuttingSectionKey (Key const &in_that) | |
CuttingSectionKey (CuttingSectionKey const &in_that) | |
CuttingSectionKey (CuttingSectionKey &&in_that) | |
CuttingSectionKey & | EditPlanesByDeletion (size_t in_offset, size_t in_count) |
CuttingSectionKey & | EditPlanesByInsertion (size_t in_offset, size_t in_count, Plane const in_planes[]) |
CuttingSectionKey & | EditPlanesByInsertion (size_t in_offset, PlaneArray const &in_planes) |
CuttingSectionKey & | EditPlanesByReplacement (size_t in_offset, size_t in_count, Plane const in_planes[]) |
CuttingSectionKey & | EditPlanesByReplacement (size_t in_offset, PlaneArray const &in_planes) |
size_t | GetPlaneCount () const |
Type | ObjectType () const |
CuttingSectionKey & | operator= (CuttingSectionKey const &in_that) |
CuttingSectionKey & | operator= (CuttingSectionKey &&in_that) |
void | Set (CuttingSectionKit const &in_kit) |
CuttingSectionKey & | SetPlanes (Plane const &in_plane) |
CuttingSectionKey & | SetPlanes (PlaneArray const &in_planes) |
CuttingSectionKey & | SetPlanes (size_t in_count, Plane const in_planes[]) |
CuttingSectionKey & | SetVisualization (CuttingSection::Mode in_mode, RGBAColor const &in_color, float in_scale=1.0f) |
void | Show (CuttingSectionKit &out_kit) const |
bool | ShowPlanes (PlaneArray &out_planes) const |
bool | ShowVisualization (CuttingSection::Mode &out_mode, RGBAColor &out_color, float &out_scale) const |
![]() | |
GeometryKey () | |
GeometryKey (Key const &in_that) | |
GeometryKey (GeometryKey const &in_that) | |
GeometryKey (GeometryKey &&in_that) | |
GeometryKey & | operator= (GeometryKey const &in_that) |
GeometryKey & | operator= (GeometryKey &&in_that) |
GeometryKey & | SetPriority (int in_priority) |
GeometryKey & | SetUserData (intptr_t in_index, size_t in_bytes, byte const in_data[]) |
GeometryKey & | SetUserData (intptr_t in_index, ByteArray const &in_data) |
GeometryKey & | SetUserData (IntPtrTArray const &in_indices, ByteArrayArray const &in_data) |
bool | ShowBoundings (BoundingKit &out_kit) const |
bool | ShowPriority (int &out_priority) const |
size_t | ShowReferrers (SegmentKeyArray &out_segments) const |
size_t | ShowReferrers (ReferenceKeyArray &out_references) 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 |
GeometryKey & | UnsetAllUserData () |
GeometryKey & | UnsetPriority () |
GeometryKey & | UnsetUserData (intptr_t in_index) |
GeometryKey & | UnsetUserData (size_t in_count, intptr_t const in_indices[]) |
GeometryKey & | UnsetUserData (IntPtrTArray const &in_indices) |
![]() | |
virtual void | Assign (Key const &in_that) |
Key | CopyTo (SegmentKey const &in_destination) const |
void | Delete () |
bool | Equals (Key const &in_that) const |
size_t | GetHash () const |
bool | HasOwner () const |
Key () | |
Key (Key const &in_that) | |
Key (Control const &in_control) | |
Key (Key &&in_that) | |
void | MoveTo (SegmentKey const &in_new_owner) |
bool | operator!= (Key const &in_that) const |
Key & | operator= (Key &&in_that) |
Key & | operator= (Key const &in_that) |
bool | operator== (Key const &in_that) const |
SegmentKey | Owner () const |
SegmentKey | Up () const |
virtual | ~Key () |
![]() | |
virtual bool | Empty () const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (Type in_mask) const |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
Type | Type () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
The CuttingSectionKey class is a smart pointer to a database object. It is a handle to a cutting section inserted via SegmentKey::InsertCuttingSection.
CuttingSectionKey::CuttingSectionKey | ( | ) |
The default constructor creates an uninitialized CuttingSectionKey object. The Type() function will return Type::None.
|
explicit |
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.
in_key | The source Key to copy. |
CuttingSectionKey::CuttingSectionKey | ( | CuttingSectionKey const & | in_that | ) |
The copy constructor creates a CuttingSectionKey object that shares the underlying smart-pointer of the source CuttingSectionKey.
in_that | The source CuttingSectionKey to copy. |
CuttingSectionKey::CuttingSectionKey | ( | CuttingSectionKey && | in_that | ) |
The move constructor creates a CuttingSectionKey by transferring the underlying impl of the rvalue reference to this CuttingSectionKey thereby avoiding a copy and allocation.
in_that | An rvalue reference to a CuttingSectionKey to take the impl from. |
void CuttingSectionKey::Consume | ( | CuttingSectionKit & | in_kit | ) |
Completely replaces all settings on this CuttingSectionKey with those set on the specified kit and resets the kit.
in_kit | The kit from which to get the settings to replace on this CuttingSectionKey. |
CuttingSectionKey& CuttingSectionKey::EditPlanesByDeletion | ( | size_t | in_offset, |
size_t | in_count | ||
) |
Removes planes from the cutting plane list for this CuttingSectionKey.
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. |
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. |
CuttingSectionKey& CuttingSectionKey::EditPlanesByInsertion | ( | size_t | in_offset, |
size_t | in_count, | ||
Plane const | in_planes[] | ||
) |
Adds cutting planes to this CuttingSectionKey.
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. |
in_count | Size of the following array. |
in_planes | The planes to insert into the cutting plane list at the specified offset. |
CuttingSectionKey& CuttingSectionKey::EditPlanesByInsertion | ( | size_t | in_offset, |
PlaneArray const & | in_planes | ||
) |
Adds cutting planes to this CuttingSectionKey.
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. |
in_planes | The planes to insert into the cutting plane list at the specified offset. |
CuttingSectionKey& CuttingSectionKey::EditPlanesByReplacement | ( | size_t | in_offset, |
size_t | in_count, | ||
Plane const | in_planes[] | ||
) |
Replaces planes in the cutting plane list for this CuttingSectionKey.
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. |
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. |
CuttingSectionKey& CuttingSectionKey::EditPlanesByReplacement | ( | size_t | in_offset, |
PlaneArray const & | in_planes | ||
) |
Replaces planes in the cutting plane list for this CuttingSectionKey.
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. |
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. |
size_t CuttingSectionKey::GetPlaneCount | ( | ) | const |
Gets the number of cutting planes for this CuttingSectionKey.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from GeometryKey.
CuttingSectionKey& CuttingSectionKey::operator= | ( | CuttingSectionKey const & | in_that | ) |
Associate this CuttingSectionKey with the same underlying impl as the source CuttingSectionKey.
in_that | The source CuttingSectionKey for the assignment. |
CuttingSectionKey& CuttingSectionKey::operator= | ( | CuttingSectionKey && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this CuttingSectionKey thereby avoiding a copy.
in_that | An rvalue reference to a CuttingSectionKey to take the impl from. |
void CuttingSectionKey::Set | ( | CuttingSectionKit const & | in_kit | ) |
Replace those settings on this CuttingSectionKey with those set on the specified kit.
in_kit | The kit from which to get the settings to replace on this CuttingSectionKey. |
CuttingSectionKey& CuttingSectionKey::SetPlanes | ( | Plane const & | in_plane | ) |
Sets a single cutting plane for this CuttingSectionKey.
in_plane | The cutting plane for this CuttingSectionKey. |
CuttingSectionKey& CuttingSectionKey::SetPlanes | ( | PlaneArray const & | in_planes | ) |
Sets multiple cutting planes for this CuttingSectionKey.
in_planes | The cutting planes for this CuttingSectionKey. |
CuttingSectionKey& CuttingSectionKey::SetPlanes | ( | size_t | in_count, |
Plane const | in_planes[] | ||
) |
Sets multiple cutting planes for this CuttingSectionKey.
in_count | Size of the following array. |
in_planes | The cutting planes for this CuttingSectionKey. |
CuttingSectionKey& CuttingSectionKey::SetVisualization | ( | CuttingSection::Mode | in_mode, |
RGBAColor const & | in_color, | ||
float | in_scale = 1.0f |
||
) |
Sets visualization to use for this CuttingSectionKey.
in_mode | The mode for the CuttingSectionKey. |
in_color | The RGBA color for the CuttingSectionKey. |
in_scale | The scale to apply to the visualization geometry for this CuttingSectionKey. Defaults to 1.0f. |
void CuttingSectionKey::Show | ( | CuttingSectionKit & | out_kit | ) | const |
Copy the contents of this CuttingSectionKey into the specified kit.
out_kit | The kit to populate with the contents of this CuttingSectionKey. |
bool CuttingSectionKey::ShowPlanes | ( | PlaneArray & | out_planes | ) | const |
Shows the cutting planes for this CuttingSectionKey.
out_planes | The cutting planes for this CuttingSectionKey. |
bool CuttingSectionKey::ShowVisualization | ( | CuttingSection::Mode & | out_mode, |
RGBAColor & | out_color, | ||
float & | out_scale | ||
) | const |
Shows the visualization to use for this CuttingSectionKey.
out_mode | The mode for this CuttingSectionKey. |
out_color | The RGBA color for this CuttingSectionKey. |
out_scale | The scale to apply to the visualization geometry for this CuttingSectionKey. |