#include <hps.h>

Public Member Functions | |
ModellingMatrixControl | GetModellingMatrixControl () |
ModellingMatrixControl const | GetModellingMatrixControl () const |
Key | GetTarget () const |
HPS::Type | ObjectType () const |
ReferenceKey & | operator= (ReferenceKey const &in_that) |
ReferenceKey & | operator= (ReferenceKey &&in_that) |
ReferenceKey () | |
ReferenceKey (Key const &in_that) | |
ReferenceKey (ReferenceKey const &in_that) | |
ReferenceKey (ReferenceKey &&in_that) | |
ReferenceKey & | SetConditionalExpression (ConditionalExpression const &in_conditional) |
ReferenceKey & | SetGeometryMask (SearchTypeArray const &in_geometry_types) |
void | SetModellingMatrix (MatrixKit const &in_kit) |
bool | ShowConditionalExpression (ConditionalExpression &out_conditional) const |
size_t | ShowGeometryMask () const |
size_t | ShowGeometryMask (SearchTypeArray &out_geometry_types) const |
bool | ShowModellingMatrix (MatrixKit &out_kit) const |
size_t | ShowTargets (bool masked=true) const |
size_t | ShowTargets (KeyArray &out_keys, bool masked=true) const |
ReferenceKey & | UnsetConditionalExpression () |
ReferenceKey & | UnsetGeometryMask () |
void | UnsetModellingMatrix () |
![]() | |
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 |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Detailed Description
The ReferenceKey class is a smart pointer to a database object. It is a handle to a geometry reference returned by SegmentKey::ReferenceGeometry.
Constructor & Destructor Documentation
HPS::ReferenceKey::ReferenceKey | ( | ) |
The default constructor creates an uninitialized ReferenceKey object. The Type() function will return Type::None.
|
explicit |
This constructor creates an ReferenceKey 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 reference key. Otherwise the copy will fail and the resulting ReferenceKey will be invalid.
- Parameters
-
in_key The source Key to copy.
HPS::ReferenceKey::ReferenceKey | ( | ReferenceKey const & | in_that | ) |
The copy constructor creates a ReferenceKey object that shares the underlying smart-pointer of the source ReferenceKey.
- Parameters
-
in_that The source ReferenceKey to copy.
HPS::ReferenceKey::ReferenceKey | ( | ReferenceKey && | in_that | ) |
The move constructor creates a ReferenceKey by transferring the underlying impl of the rvalue reference to this ReferenceKey thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to a ReferenceKey to take the impl from.
Member Function Documentation
ModellingMatrixControl HPS::ReferenceKey::GetModellingMatrixControl | ( | ) |
Gets a control that allows querying and modifying modelling matrices set on this reference.
- Returns
- A control that allows querying and modifying modelling matrices set on this reference.
ModellingMatrixControl const HPS::ReferenceKey::GetModellingMatrixControl | ( | ) | const |
Gets a control that allows querying modelling matrices set on this reference.
- Returns
- A control that allows querying modelling matrices set on this reference.
Key HPS::ReferenceKey::GetTarget | ( | ) | const |
Gets the geometry or segment key that was used to create this ReferenceKey. If multiple geometry are referenced only the first is returned.
- Returns
- The geometry or segment key that was used to create this ReferenceKey.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::GeometryKey.
ReferenceKey& HPS::ReferenceKey::operator= | ( | ReferenceKey const & | in_that | ) |
Associate this ReferenceKey with the same underlying impl as the source ReferenceKey.
- Parameters
-
in_that The source ReferenceKey for the assignment.
- Returns
- A reference to this ReferenceKey.
ReferenceKey& HPS::ReferenceKey::operator= | ( | ReferenceKey && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this ReferenceKey thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to a ReferenceKey to take the impl from.
- Returns
- A reference to this ReferenceKey.
ReferenceKey& HPS::ReferenceKey::SetConditionalExpression | ( | ConditionalExpression const & | in_conditional | ) |
Sets a conditional expression on this ReferenceKey. This will either make an unconditional reference into a conditional reference, or modify the condition for an existing conditional reference. The target geometry or segment referenced by this reference will only be drawn in the owning segment if a condition satisfying the given conditional expression is set above this reference in the tree.
- Parameters
-
in_conditional The conditional expression for this ReferenceKey.
- Returns
- A reference to this ReferenceKey.
ReferenceKey& HPS::ReferenceKey::SetGeometryMask | ( | SearchTypeArray const & | in_geometry_types | ) |
Sets the masked geometry types. Only the geometry types included in the mask will be processed by this ReferenceKey. Set HPS::Search::Type::Geometry to process all geometry types.
- Parameters
-
in_geometry_types The geometry types to be processed by this reference.
void HPS::ReferenceKey::SetModellingMatrix | ( | MatrixKit const & | in_kit | ) |
Sets the specified modelling matrix on this reference.
- Parameters
-
in_kit The modelling matrix to set on this reference.
bool HPS::ReferenceKey::ShowConditionalExpression | ( | ConditionalExpression & | out_conditional | ) | const |
Shows the conditional expression for this ReferenceKey.
- Parameters
-
out_conditional The conditional expression for this ReferenceKey.
- Returns
- true if a conditional expression is set on this ReferenceKey, false otherwise.
size_t HPS::ReferenceKey::ShowGeometryMask | ( | ) | const |
Gets the count of masked geometry types. Only the geometry types included in the mask will be processed by this ReferenceKey. If no mask was explicitly set the mask size is one and the value is HPS::Search::Type::Geometry.
- Returns
- A count of masked geometry types from this reference.
size_t HPS::ReferenceKey::ShowGeometryMask | ( | SearchTypeArray & | out_geometry_types | ) | const |
Gets the masked geometry types. Only the geometry types included in the mask will be processed by this ReferenceKey. If no mask was explicitly set the mask size is one and the value is HPS::Search::Type::Geometry.
- Parameters
-
out_geometry_types The geometry types processed by this reference.
- Returns
- A count of masked geometry types from this reference.
bool HPS::ReferenceKey::ShowModellingMatrix | ( | MatrixKit & | out_kit | ) | const |
Shows the modelling matrix on this reference.
- Parameters
-
out_kit The modelling matrix set on this reference.
- Returns
- true if a modelling matrix was set, false otherwise.
size_t HPS::ReferenceKey::ShowTargets | ( | bool | masked = true | ) | const |
Gets the count of geometry keys or a segment key targeted by this ReferenceKey.
- Parameters
-
masked If true a geometry mask if present will be applied to the results.
- Returns
- A count of targeted geometries or a segment from this reference.
size_t HPS::ReferenceKey::ShowTargets | ( | KeyArray & | out_keys, |
bool | masked = true |
||
) | const |
Gets the geometries keys or a segment key targeted by this ReferenceKey.
- Parameters
-
out_keys The keys targeted by this reference. masked If true a geometry mask if present will be applied to the results.
- Returns
- A count of targeted geometries or segment from this reference and populates out_keys with their keys.
ReferenceKey& HPS::ReferenceKey::UnsetConditionalExpression | ( | ) |
Removes the conditional expression on this ReferenceKey. This will turn a conditional reference into an unconditional reference.
- Returns
- A reference to this ReferenceKey.
ReferenceKey& HPS::ReferenceKey::UnsetGeometryMask | ( | ) |
Resets the masked geometry types on this ReferenceKey to HPS::Search::Type::Geometry.
- Returns
- A reference to this ReferenceKey.
void HPS::ReferenceKey::UnsetModellingMatrix | ( | ) |
Removes the modelling matrix on this geometry reference.
The documentation for this class was generated from the following file:
- include/hps.h