Cisco Packet Tracer Extensions API 8.1.0
API for communication between Cisco Packet Tracer application and its extension applications and modules.
Public Member Functions | List of all members
GeoIcon Class Reference

GeoIcon handles and manipulates component items, such as devices, on the workspace. More...

Public Member Functions

void setVisible (bool)
 Shows or hides the component item. More...
 
int type ()
 Returns the type of the component item. More...
 
void moveBy (double, double)
 Moves the component item by the specified x and y values. More...
 
void moveTo (double, double)
 Moves the component item to the specified coordinates. More...
 
PhysicalObject getPhysicalObject ()
 Returns the device. More...
 

Detailed Description

GeoIcon handles and manipulates component items, such as devices, on the workspace.

Member Function Documentation

◆ getPhysicalObject()

PhysicalObject GeoIcon::getPhysicalObject ( )

Returns the device.

Returns
Device, the device object.

◆ moveBy()

void GeoIcon::moveBy ( double  ,
double   
)

Moves the component item by the specified x and y values.

Parameters
x,thevalue to move the component item by on the x-axis.
y,thevalue to move the component item by on the y-axis.

◆ moveTo()

void GeoIcon::moveTo ( double  ,
double   
)

Moves the component item to the specified coordinates.

Parameters
x,thevalue to move the component item to on the x-axis.
y,thevalue to move the component item to on the y-axis.

◆ setVisible()

void GeoIcon::setVisible ( bool  )

Shows or hides the component item.

Parameters
bVisible,trueto show the component item, false to hide it.

◆ type()

int GeoIcon::type ( )

Returns the type of the component item.

Returns
int, the type of component. Types: COMPONENT = 1100, CONNECTION = 1101, NOTE = 1102, PACKET = 1103, CLUSTER = 1104, RECTANGLE = 1105, LINE = 1106, ELLIPSE = 1107, MULTIUSERITEM = 1108, QOSPACKET = 1109, RESIZEINDICATOR = 1110, ACCESSORYITEM = 1111, POLYGON = 1112, TEXTPOPUP = 1113

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