HPS::CircularWedgeKey Class Reference

#include <hps.h>

Inheritance diagram for HPS::CircularWedgeKey:
HPS::GeometryKey HPS::Key HPS::Object

Public Member Functions

 CircularWedgeKey ()
 
 CircularWedgeKey (Key const &in_that)
 
 CircularWedgeKey (CircularWedgeKey const &in_that)
 
 CircularWedgeKey (CircularWedgeKey &&in_that)
 
void Consume (CircularWedgeKit &in_kit)
 
HPS::Type ObjectType () const
 
CircularWedgeKeyoperator= (CircularWedgeKey const &in_that)
 
CircularWedgeKeyoperator= (CircularWedgeKey &&in_that)
 
void Set (CircularWedgeKit const &in_kit)
 
CircularWedgeKeySetEnd (Point const &in_end)
 
CircularWedgeKeySetMiddle (Point const &in_middle)
 
CircularWedgeKeySetStart (Point const &in_start)
 
void Show (CircularWedgeKit &out_kit) const
 
bool ShowEnd (Point &out_end) const
 
bool ShowMiddle (Point &out_middle) const
 
bool ShowStart (Point &out_start) const
 
- Public Member Functions inherited from HPS::GeometryKey
 GeometryKey ()
 
 GeometryKey (Key const &in_that)
 
 GeometryKey (GeometryKey const &in_that)
 
 GeometryKey (GeometryKey &&in_that)
 
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::CircularWedgeKey
 
- Static Public Attributes inherited from HPS::GeometryKey
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 ()
 

Detailed Description

The CircularWedgeKey class is a smart pointer to a database object. It is a handle to a circular wedge inserted via SegmentKey::InsertCircularWedge. A circular wedge has face geometry contained within the boundary edges of the circular wedge. The visualization of the wedge will be determined by attribute settings affecting faces and edges.

Constructor & Destructor Documentation

◆ CircularWedgeKey() [1/4]

HPS::CircularWedgeKey::CircularWedgeKey ( )

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

◆ CircularWedgeKey() [2/4]

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

This constructor creates a CircularWedgeKey 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 CircularWedge key. Otherwise the copy will fail and the resulting CircularWedgeKey will be invalid.

Parameters
in_keyThe source Key to copy.

◆ CircularWedgeKey() [3/4]

HPS::CircularWedgeKey::CircularWedgeKey ( CircularWedgeKey const &  in_that)

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

Parameters
in_thatThe source CircularWedgeKey to copy.

◆ CircularWedgeKey() [4/4]

HPS::CircularWedgeKey::CircularWedgeKey ( CircularWedgeKey &&  in_that)

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

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

Member Function Documentation

◆ Consume()

void HPS::CircularWedgeKey::Consume ( CircularWedgeKit in_kit)

Completely replaces all settings on this CircularWedgeKey with those set on the specified kit and resets the kit.

Parameters
in_kitThe kit from which to get the settings to replace on this CircularWedgeKey.

◆ ObjectType()

HPS::Type HPS::CircularWedgeKey::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]

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

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

Parameters
in_thatThe source CircularWedgeKey for the assignment.
Returns
A reference to this CircularWedgeKey.

◆ operator=() [2/2]

CircularWedgeKey& HPS::CircularWedgeKey::operator= ( CircularWedgeKey &&  in_that)

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

Parameters
in_thatAn rvalue reference to a CircularWedgeKey to take the impl from.
Returns
A reference to this CircularWedgeKey.

◆ Set()

void HPS::CircularWedgeKey::Set ( CircularWedgeKit const &  in_kit)

Replace those settings on this CircularWedgeKey with those set on the specified kit.

Parameters
in_kitThe kit from which to get the settings to replace on this CircularWedgeKey.

◆ SetEnd()

CircularWedgeKey& HPS::CircularWedgeKey::SetEnd ( Point const &  in_end)

Sets the end point for this CircularWedgeKey. This is the point on the circumference of the circle at which the circular wedge ends.

Parameters
in_endThe end point for this CircularWedgeKey.
Returns
A reference to this CircularWedgeKey.

◆ SetMiddle()

CircularWedgeKey& HPS::CircularWedgeKey::SetMiddle ( Point const &  in_middle)

Sets the middle point for this CircularWedgeKey. This is a point on the circumference of the circle between the start and end points for the circular wedge.

Parameters
in_middleThe middle point for this CircularWedgeKey.
Returns
A reference to this CircularWedgeKey.

◆ SetStart()

CircularWedgeKey& HPS::CircularWedgeKey::SetStart ( Point const &  in_start)

Sets the start point for this CircularWedgeKey. This is the point on the circumference of the circle at which the circular wedge starts.

Parameters
in_startThe start point for this CircularWedgeKey.
Returns
A reference to this CircularWedgeKey.

◆ Show()

void HPS::CircularWedgeKey::Show ( CircularWedgeKit out_kit) const

Copy the contents of this CircularWedgeKey into the specified kit.

Parameters
out_kitThe kit to populate with the contents of this CircularWedgeKey.

◆ ShowEnd()

bool HPS::CircularWedgeKey::ShowEnd ( Point out_end) const

Shows the end point for this CircularWedgeKey.

Parameters
out_endThe end point for this CircularWedgeKey.
Returns
true if an end point was set, false otherwise.

◆ ShowMiddle()

bool HPS::CircularWedgeKey::ShowMiddle ( Point out_middle) const

Shows the middle point for this CircularWedgeKey.

Parameters
out_middleThe middle point for this CircularWedgeKey.
Returns
true if a middle point was set, false otherwise.

◆ ShowStart()

bool HPS::CircularWedgeKey::ShowStart ( Point out_start) const

Shows the start point for this CircularWedgeKey.

Parameters
out_startThe start point for this CircularWedgeKey.
Returns
true if a start point was set, false otherwise.

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