API Search || Global Search
HPS::CircularArcKey Class Reference

#include <hps.h>

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

Public Member Functions

 CircularArcKey ()
 
 CircularArcKey (Key const &in_that)
 
 CircularArcKey (CircularArcKey const &in_that)
 
 CircularArcKey (CircularArcKey &&in_that)
 
void Consume (CircularArcKit &in_kit)
 
HPS::Type ObjectType () const
 
CircularArcKeyoperator= (CircularArcKey const &in_that)
 
CircularArcKeyoperator= (CircularArcKey &&in_that)
 
void Set (CircularArcKit const &in_kit)
 
CircularArcKeySetEnd (Point const &in_end)
 
CircularArcKeySetMiddle (Point const &in_middle)
 
CircularArcKeySetStart (Point const &in_start)
 
void Show (CircularArcKit &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::CircularArcKey
 
- 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 CircularArcKey class is a smart pointer to a database object. It is handle to a circular arc inserted via SegmentKey::InsertCircularArc. A circular arc is the line geometry, as such its visualization will be determined by attributes affecting lines.

Constructor & Destructor Documentation

HPS::CircularArcKey::CircularArcKey ( )

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

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

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

Parameters
in_keyThe source Key to copy.
HPS::CircularArcKey::CircularArcKey ( CircularArcKey const &  in_that)

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

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

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

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

Member Function Documentation

void HPS::CircularArcKey::Consume ( CircularArcKit in_kit)

Completely replaces all settings on this CircularArcKey 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 CircularArcKey.
CircularArcKey& HPS::CircularArcKey::operator= ( CircularArcKey const &  in_that)

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

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

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

Parameters
in_thatAn rvalue reference to a CircularArcKey to take the impl from.
Returns
A reference to this CircularArcKey.
void HPS::CircularArcKey::Set ( CircularArcKit const &  in_kit)

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

Parameters
in_kitThe kit from which to get the settings to replace on this CircularArcKey.
CircularArcKey& HPS::CircularArcKey::SetEnd ( Point const &  in_end)

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

Parameters
in_endThe end point for this CircularArcKey.
Returns
A reference to this CircularArcKey.
CircularArcKey& HPS::CircularArcKey::SetMiddle ( Point const &  in_middle)

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

Parameters
in_middleThe middle point for this CircularArcKey.
Returns
A reference to this CircularArcKey.
CircularArcKey& HPS::CircularArcKey::SetStart ( Point const &  in_start)

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

Parameters
in_startThe start point for this CircularArcKey.
Returns
A reference to this CircularArcKey.
void HPS::CircularArcKey::Show ( CircularArcKit out_kit) const

Copy the contents of this CircularArcKey into the specified kit.

Parameters
out_kitThe kit to populate with the contents of this CircularArcKey.
bool HPS::CircularArcKey::ShowEnd ( Point out_end) const

Shows the end point for this CircularArcKey.

Parameters
out_endThe end point for this CircularArcKey.
Returns
true if an end point was set, false otherwise.
bool HPS::CircularArcKey::ShowMiddle ( Point out_middle) const

Shows the middle point for this CircularArcKey.

Parameters
out_middleThe middle point for this CircularArcKey.
Returns
true if a middle point was set, false otherwise.
bool HPS::CircularArcKey::ShowStart ( Point out_start) const

Shows the start point for this CircularArcKey.

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

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