API Search || Global Search
Inheritance diagram for HPS::GeometryKey:
HPS::Key HPS::Object HPS::CircleKey HPS::CircularArcKey HPS::CircularWedgeKey HPS::CuttingSectionKey HPS::CylinderKey HPS::DistantLightKey HPS::EllipseKey HPS::EllipticalArcKey HPS::GridKey HPS::InfiniteLineKey HPS::LineKey HPS::MarkerKey HPS::MeshKey HPS::NURBSCurveKey HPS::NURBSSurfaceKey HPS::PolygonKey HPS::ReferenceKey HPS::ShellKey HPS::SphereKey HPS::SpotlightKey HPS::TextKey

Public Member Functions

 GeometryKey ()
 
 GeometryKey (Key const &in_that)
 
 GeometryKey (GeometryKey const &in_that)
 
 GeometryKey (GeometryKey &&in_that)
 
HPS::Type ObjectType () const
 
GeometryKeyoperator= (GeometryKey const &in_that)
 
GeometryKeyoperator= (GeometryKey &&in_that)
 
GeometryKeySetPriority (int in_priority)
 
GeometryKeySetUserData (intptr_t in_index, size_t in_bytes, byte const in_data[])
 
GeometryKeySetUserData (intptr_t in_index, ByteArray const &in_data)
 
GeometryKeySetUserData (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
 
GeometryKeyUnsetAllUserData ()
 
GeometryKeyUnsetPriority ()
 
GeometryKeyUnsetUserData (intptr_t in_index)
 
GeometryKeyUnsetUserData (size_t in_count, intptr_t const in_indices[])
 
GeometryKeyUnsetUserData (IntPtrTArray const &in_indices)
 
- Public Member Functions inherited from HPS::Key
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
 
Keyoperator= (Key &&in_that)
 
Keyoperator= (Key const &in_that)
 
bool operator== (Key const &in_that) const
 
SegmentKey Owner () const
 
SegmentKey Up () const
 
virtual ~Key ()
 
- Public Member Functions inherited from HPS::Object
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)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::GeometryKey
 
- Static Public Attributes inherited from HPS::Key
static const HPS::Type staticType = HPS::Type::Key
 
- 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 ()
 

Constructor & Destructor Documentation

HPS::GeometryKey::GeometryKey ( )

The default constructor creates an uninitialized GeometryKey object. The Type() function will return Type::None.

HPS::GeometryKey::GeometryKey ( Key const &  in_that)
explicit

This constructor creates a GeometryKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really a type of geometry key. Otherwise the copy will fail and the resulting GeometryKey will be invalid.

Parameters
in_thatThe source Key to copy.
HPS::GeometryKey::GeometryKey ( GeometryKey const &  in_that)

The copy constructor creates a GeometryKey object that shares the underlying smart-pointer of the source GeometryKey.

Parameters
in_thatThe source GeometryKey to copy.
HPS::GeometryKey::GeometryKey ( GeometryKey &&  in_that)

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

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

Member Function Documentation

GeometryKey& HPS::GeometryKey::operator= ( GeometryKey const &  in_that)

Associate this GeometryKey with the same underlying impl as the source GeometryKey.

Parameters
in_thatThe source GeometryKey for the assignment.
Returns
A reference to this GeometryKey.
GeometryKey& HPS::GeometryKey::operator= ( GeometryKey &&  in_that)

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

Parameters
in_thatAn rvalue reference to a GeometryKey to take the impl from.
Returns
A reference to this GeometryKey.
GeometryKey& HPS::GeometryKey::SetPriority ( int  in_priority)

Assigns a drawing priority value to the geometry. It affects the order in which the geometry is visited if and only if the rendering algorithm is set to Priority. The geometry has a default drawing priority assigned, based on the order of insertion.

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::SetRenderingAlgorithm()
GeometryKey& HPS::GeometryKey::SetUserData ( intptr_t  in_index,
size_t  in_bytes,
byte const  in_data[] 
)

Sets user data on this key.

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 key.
GeometryKey& HPS::GeometryKey::SetUserData ( intptr_t  in_index,
ByteArray const &  in_data 
)

Sets user data on this key.

Parameters
in_indexThe index of the user data to set.
in_dataThe bytes of user data to set.
Returns
A reference to this key.
GeometryKey& HPS::GeometryKey::SetUserData ( IntPtrTArray const &  in_indices,
ByteArrayArray const &  in_data 
)

Sets user data on this key.

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 key.
bool HPS::GeometryKey::ShowBounding ( BoundingKit out_kit) const

Shows the bounding of this geometry.

Parameters
out_kitThe BoundingKit that is set on this GeometryKey
Returns
False if no bounding exists.
bool HPS::GeometryKey::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 a priority was specified, false otherwise.
size_t HPS::GeometryKey::ShowReferrers ( SegmentKeyArray out_segments) const

Shows the all the segments which contain references to this key. Note that while a segment may only appear once in the returned array, that segment could have multiple references to this key.

Parameters
out_segmentsThe list of segments which contains references to this key.
Returns
The number of segments which contain references to this key.
size_t HPS::GeometryKey::ShowReferrers ( ReferenceKeyArray out_references) const

Shows the all the references to this key.

Parameters
out_referencesThe list of all references to this key.
Returns
The number of references to this key.
bool HPS::GeometryKey::ShowUserData ( intptr_t  in_index,
ByteArray out_data 
) const

Shows the user data at a given index for this key.

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.
bool HPS::GeometryKey::ShowUserData ( IntPtrTArray out_indices,
ByteArrayArray out_data 
) const

Shows all user data for this key.

Parameters
out_indicesAn array of all user data indices set on this key.
out_dataAn array of all user data set on this key.
Returns
true if there is user data on this key, false otherwise.
size_t HPS::GeometryKey::ShowUserDataCount ( ) const

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

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

Shows the indices of all user data set on this key.

Parameters
out_indicesThe user data indices set on this key.
Returns
The number of user data indices set on this key.
GeometryKey& HPS::GeometryKey::UnsetAllUserData ( )

Removes all user data from this key.

Returns
A reference to this key.
GeometryKey& HPS::GeometryKey::UnsetPriority ( )

Removes the drawing priority setting.

Returns
A reference to this object.
GeometryKey& HPS::GeometryKey::UnsetUserData ( intptr_t  in_index)

Removes the user data at the given index from this key.

Parameters
in_indexThe index of the user data to remove.
Returns
A reference to this key.
GeometryKey& HPS::GeometryKey::UnsetUserData ( size_t  in_count,
intptr_t const  in_indices[] 
)

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

Parameters
in_countThe size of the following array.
in_indicesThe indices of the user data to remove.
Returns
A reference to this key.
GeometryKey& HPS::GeometryKey::UnsetUserData ( IntPtrTArray const &  in_indices)

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

Parameters
in_indicesThe indices of the user data to remove.
Returns
A reference to this key.

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