Maps SDK for C++ 1.0.0
Loading...
Searching...
No Matches
gem::AbstractGeometryItem Class Reference

AbstractGeometryItem object. More...

Inheritance diagram for gem::AbstractGeometryItem:
Collaboration diagram for gem::AbstractGeometryItem:

Public Member Functions

 AbstractGeometryItem (const AbstractGeometryItem &)=default
 Default copy constructor.
 AbstractGeometryItem (AbstractGeometryItem &&)=default
 Default move constructor noexcept is deduced.
AbstractGeometryItem & operator= (const AbstractGeometryItem &geomitem)=default
 Default copy assignment.
AbstractGeometryItem & operator= (AbstractGeometryItem &&geomitem)=default
 Default move assignment noexcept is deduced.
EShapeForm getShapeForm () const noexcept
 Get the shape form.
EShapeType getShapeType () const noexcept
 Get the shape type.
EArrowType getArrowType () const noexcept
 Get the arrow type.
ERestrictionType getRestrictionType () const noexcept
 Get the restriction type.
int getBeginSlot (bool bHD=false) const noexcept
 Get the slot the shape begin is attached to the anchor.
EArrowDirection getBeginArrowDirection () const noexcept
 Get the arrow direction at the begin.
int getEndSlot (bool bHD=false) const noexcept
 Get the slot the shape end is attached to the anchor.
EArrowDirection getEndArrowDirection () const noexcept
 Get the arrow direction at the end.
int getSlotAllocation () const noexcept
 Get the slot allocation.

Detailed Description

AbstractGeometryItem object.

Implements share-read / copy-on-write Api object over IAbstractGeometryItem.

Member Function Documentation

◆ getArrowType()

EArrowType gem::AbstractGeometryItem::getArrowType ( ) const
inlinenoexcept

Get the arrow type.

Returns
The arrow type.

◆ getBeginArrowDirection()

EArrowDirection gem::AbstractGeometryItem::getBeginArrowDirection ( ) const
inlinenoexcept

Get the arrow direction at the begin.

Returns
The arrow direction at the begin.

◆ getBeginSlot()

int gem::AbstractGeometryItem::getBeginSlot ( bool bHD = false) const
inlinenoexcept

Get the slot the shape begin is attached to the anchor.

The begin slot references the position where the begin shape is attached to the anchor,

Parameters
bHDEnable high definition mode (more slots). Default false. HD mode = false : 12 slots are possible, -1 indicates N/A. HD mode = true : 20 slots are possible, -1 indicates N/A. -1 indicates N/A. The numbers indicate position similar to a clock face.
Returns
The slot the shape begin is attached to the anchor.

◆ getEndArrowDirection()

EArrowDirection gem::AbstractGeometryItem::getEndArrowDirection ( ) const
inlinenoexcept

Get the arrow direction at the end.

Returns
The arrow direction at the end.

◆ getEndSlot()

int gem::AbstractGeometryItem::getEndSlot ( bool bHD = false) const
inlinenoexcept

Get the slot the shape end is attached to the anchor.

The begin slot references the position where the end shape is attached to the anchor,

Parameters
bHDEnable high definition mode (more slots). Default false. HD mode = false : 12 slots are possible, -1 indicates N/A. HD mode = true : 20 slots are possible, -1 indicates N/A. -1 indicates N/A. The numbers indicate position similar to a clock face. TShapeForm::ESF_CircleSegment follows the circle from begin to end slot, TShapeForm::ESF_Line spans over the circle from begin to end slot
Returns
The slot the shape end is attached to the anchor.

◆ getRestrictionType()

ERestrictionType gem::AbstractGeometryItem::getRestrictionType ( ) const
inlinenoexcept

Get the restriction type.

Returns
The restriction type.

◆ getShapeForm()

EShapeForm gem::AbstractGeometryItem::getShapeForm ( ) const
inlinenoexcept

Get the shape form.

Returns
The shape form.

◆ getShapeType()

EShapeType gem::AbstractGeometryItem::getShapeType ( ) const
inlinenoexcept

Get the shape type.

Returns
The shape type.

◆ getSlotAllocation()

int gem::AbstractGeometryItem::getSlotAllocation ( ) const
inlinenoexcept

Get the slot allocation.

The slot allocation indicates how many shapes are occupying a slot. The rendering should reflect this by different dividers.

Returns
The slot allocation.

◆ operator=() [1/2]

AbstractGeometryItem & gem::AbstractGeometryItem::operator= ( AbstractGeometryItem && geomitem)
default

Default move assignment noexcept is deduced.

Parameters
geomitemThe AbstractGeometryItem object to assign
Returns
The assigned AbstractGeometryItem object

◆ operator=() [2/2]

AbstractGeometryItem & gem::AbstractGeometryItem::operator= ( const AbstractGeometryItem & geomitem)
default

Default copy assignment.

Parameters
geomitemThe AbstractGeometryItem object to assign
Returns
The assigned AbstractGeometryItem object