#include <hps.h>
|
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 |
|
HPS::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 (HPS::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 | ShowBounding (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 (HPS::Type in_mask) const |
|
| Object (Object const &that) |
|
| Object (Object &&in_that) |
|
Object & | operator= (Object const &other_object) |
|
Object & | operator= (Object &&in_that) |
|
virtual void | Reset () |
|
virtual HPS::Type | Type () const |
|
|
static const HPS::Type | staticType = HPS::Type::CuttingSectionKey |
|
static const HPS::Type | staticType = HPS::Type::GeometryKey |
|
static const HPS::Type | staticType = HPS::Type::Key |
|
static const HPS::Type | staticType = HPS::Type::None |
|
|
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() [1/4]
HPS::CuttingSectionKey::CuttingSectionKey |
( |
| ) |
|
The default constructor creates an uninitialized CuttingSectionKey object. The Type() function will return Type::None.
◆ CuttingSectionKey() [2/4]
HPS::CuttingSectionKey::CuttingSectionKey |
( |
Key const & |
in_that | ) |
|
|
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.
- Parameters
-
in_that | The source Key to copy. |
◆ CuttingSectionKey() [3/4]
◆ CuttingSectionKey() [4/4]
The move constructor creates a CuttingSectionKey by transferring the underlying impl of the rvalue reference to this CuttingSectionKey thereby avoiding a copy and allocation.
- Parameters
-
◆ Consume()
Completely replaces all settings on this CuttingSectionKey with those set on the specified kit and resets the kit.
- Parameters
-
◆ EditPlanesByDeletion()
CuttingSectionKey& HPS::CuttingSectionKey::EditPlanesByDeletion |
( |
size_t |
in_offset, |
|
|
size_t |
in_count |
|
) |
| |
Removes planes from the cutting plane list for this CuttingSectionKey.
- Parameters
-
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. |
- Returns
- A reference to this CuttingSectionKey.
◆ EditPlanesByInsertion() [1/2]
CuttingSectionKey& HPS::CuttingSectionKey::EditPlanesByInsertion |
( |
size_t |
in_offset, |
|
|
size_t |
in_count, |
|
|
Plane const |
in_planes[] |
|
) |
| |
Adds cutting planes to this CuttingSectionKey.
- Parameters
-
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. |
- Returns
- A reference to this CuttingSectionKey.
◆ EditPlanesByInsertion() [2/2]
Adds cutting planes to this CuttingSectionKey.
- Parameters
-
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. |
- Returns
- A reference to this CuttingSectionKey.
◆ EditPlanesByReplacement() [1/2]
CuttingSectionKey& HPS::CuttingSectionKey::EditPlanesByReplacement |
( |
size_t |
in_offset, |
|
|
size_t |
in_count, |
|
|
Plane const |
in_planes[] |
|
) |
| |
Replaces planes in the cutting plane list for this CuttingSectionKey.
- Parameters
-
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. |
- Returns
- A reference to this CuttingSectionKey.
◆ EditPlanesByReplacement() [2/2]
Replaces planes in the cutting plane list for this CuttingSectionKey.
- Parameters
-
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_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. |
- Returns
- A reference to this CuttingSectionKey.
◆ GetPlaneCount()
size_t HPS::CuttingSectionKey::GetPlaneCount |
( |
| ) |
const |
◆ ObjectType()
HPS::Type HPS::CuttingSectionKey::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::GeometryKey.
◆ operator=() [1/2]
◆ operator=() [2/2]
The move assignment operator transfers the underlying impl of the rvalue reference to this CuttingSectionKey thereby avoiding a copy.
- Parameters
-
- Returns
- A reference to this CuttingSectionKey.
◆ Set()
Replace those settings on this CuttingSectionKey with those set on the specified kit.
- Parameters
-
◆ SetPlanes() [1/3]
◆ SetPlanes() [2/3]
◆ SetPlanes() [3/3]
◆ SetVisualization()
◆ Show()
◆ ShowPlanes()
bool HPS::CuttingSectionKey::ShowPlanes |
( |
HPS::PlaneArray & |
out_planes | ) |
const |
Shows the cutting planes for this CuttingSectionKey.
- Parameters
-
- Returns
- true if any cutting planes were set, false otherwise.
◆ ShowVisualization()
Shows the visualization to use for this CuttingSectionKey.
- Parameters
-
- Returns
- true if visualization options were set, false otherwise.
The documentation for this class was generated from the following file: