Aimsun Next Scripting  22
Public Member Functions | List of all members
GKPolyline Class Reference
Inheritance diagram for GKPolyline:
GKGeoObject GKObject GKBaseObject GKBezierCurve GKExtrudedPolyline GKImage3D GKPedestrianObstacle GKPolygon GKObjectConnection GKSection GKSuperNodeTrajectory GKTurning GKPedestrianPolygonObstacle GKCentroid GKCrosswalkArea GKExtrudedPolygon GKGroup GKPTStation GKPedestrianRoutingNode GKPolygonWithHoles GKProblemNet GKSimulationArea GKSuperNode

Public Member Functions

 GKPolyline ()
 
uint nbPoints () const
 
const GKPointgetPoint (uint at) const
 
void setPoint (uint at, const GKPoint &p)
 
const GKPointsgetPoints () const
 
virtual void addPoint (const GKPoint &p)
 
virtual void addPointAt (int pos, const GKPoint &p)
 
virtual void removePoint (uint pos)
 
virtual void setPoints (const GKPoints &ps)
 
virtual GKCoord length2D () const
 
virtual GKCoord length3D () const
 
virtual bool canPointBeAdded (uint pos) const
 
virtual void join (const GKPolyline *pol, bool atStart)
 
virtual void removePoints (uint nbPoints, bool atStart)
 
virtual bool canBeJoined (const GKPolyline *pol) const
 
void prepend (const GKPoints &ps)
 
void add (const GKPoints &ps)
 
void setPointSelected (uint p, bool value)
 
bool isPointSelected (uint p) const
 
void selectAllPoints ()
 
void unselectAllPoints ()
 
int getNbSelPoints () const
 
virtual void changeDirection ()
 
GKCoord getSlope (int segmentPos) const
 
GKBBox getBBox () const
 
void setPenColor (const QColor &color)
 
virtual const QColor & getPenColor () const
 
void setPenStyle (const Qt::PenStyle &astyle)
 
const Qt::PenStyle & getPenStyle () const
 
void setPenSize (float size)
 
float getPenSize () const
 
void setPenSizeUnits (const GK::SizeUnits &units)
 
const GK::SizeUnitsgetPenSizeUnits () const
 
- Public Member Functions inherited from GKGeoObject
 GKGeoObject ()
 
virtual void setSelected (bool newState)
 
virtual bool isSelected () const
 
bool canBeModified () const
 
bool canBeEdited () const
 
virtual bool canBeGrouped () const
 
int getMark () const
 
void setMark (int newMark)
 
void addMark (int newMark)
 
void unmark ()
 
const QVector< int > * getMarks () const
 
uint getNumberOfMarks () const
 
GKLayergetLayer () const
 
void setLayer (GKLayer *alayer)
 
virtual void translate (const GKPoint &delta)
 
virtual void rotate (const GKPoint &center, double angle)
 
virtual void scale (const GKPoint &)
 
virtual GKCoord getAltitude () const
 
virtual void setAltitude (GKCoord value)
 
void addTopObject (GKGeoObject *)
 
QSet< GKGeoObject * > * getTopObjects () const
 
GKGeoObjectgetBottomObject () const
 
void setLabeled (bool value)
 
bool isLabeled () const
 
GKGeoContainer getContainedWay (const GKPoints &points, const GKBBox &bboxPoints) const
 
virtual GKGeoContainer doGetContainedWay (const GKBBox &myBBox, const GKPoints &points, const GKBBox &bboxPoints) const
 
GK::ConnectionType objectConnectionType (const GKGeoObject *object) const
 
QSet< GKObjectConnection * > getConnections () const
 
QSet< GKObjectConnection * > getConnections (const GKGeoObject *) const
 
bool anyConnection (const GKGeoObject *) const
 
virtual void addConnection (GKObjectConnection *)
 
virtual void removeConnection (GKObjectConnection *, GK::ObjectDeletionBehaviour)
 
virtual void changeConnectionObject (GKGeoObject *oldObject, GKGeoObject *newObject, GK::ConnectionType connectionType=GK::eConnectionUndefined)
 
virtual void removeAllConnections (GK::ObjectDeletionBehaviour)
 
virtual bool acceptConnection (GKGeoObject *object) const
 
virtual GKGeoObjectCutCmd * getCutCmd (const GKPoint &from, const GKPoint &to, bool keepConnection)
 
virtual bool exists (quint32 scenarioId) const
 
- Public Member Functions inherited from GKObject
 GKObject ()
 
 GKObject (const GKObject &o)
 
virtual void addedToCatalog ()
 
virtual void removedFromCatalog ()
 
uint getTick () const
 
virtual void increaseTick ()
 
void setTick (uint t)
 
virtual GKObjectclone (bool addItToModel=true) const
 
virtual GKObjectcloneAsTemporary (bool addItToModel=true) const
 
GKFoldergetCreateRootFolder ()
 
GKFoldergetRootFolder () const
 
void setRootFolder (GKFolder *afolder)
 
GKFolderfindFolder (const QString &byName) const
 
QVector< GKFolder * > getParentFolders () const
 
bool isDataValueNull (const GKColumn *attr) const
 
virtual QVariant * getDataValue (const GKColumn *attr, bool *deleteit, const GKContext &context=GKContext::anyContext) const
 
QVariant * getDataValueByID (uint attrId, bool *deleteit, const GKContext &context=GKContext::anyContext) const
 
virtual void setDataValue (const GKColumn *attr, const QVariant &v)
 
void setDataValueByID (uint attrId, const QVariant &v)
 
virtual void setDataValueObject (const GKColumn *attr, const GKObject *obj)
 
void setDataValueObjectByID (uint attrId, const GKObject *obj)
 
virtual void setDataValueDouble (const GKColumn *attr, double v)
 
void setDataValueDoubleByID (uint attrId, double v)
 
virtual double getDataValueInTS (const GKColumn *attr, GKTimeSerieIndex index, double *deviation=NULL) const
 
double getDataValueInTSByID (uint attrId, GKTimeSerieIndex index, double *deviation=NULL) const
 
bool hasAnyTSWithData () const
 
virtual GKTimeSeriegetDataValueTS (const GKColumn *attr) const
 
GKTimeSeriegetDataValueTSByID (uint attrId) const
 
virtual void setDataValueInTS (const GKColumn *attr, GKTimeSerieIndex index, double value, double deviation, GKTSDescription *aDescription=NULL, int reservedSize=0)
 
virtual void setDataValueInTS (const GKColumn *attr, GKTimeSerieIndex index, double value, double deviation, double lowerValue, GKTSDescription *aDescription=NULL, int reservedSize=0)
 
virtual void setDataValueInSingleTS (const GKColumn *attr, GKTimeSerieIndex index, double value, double deviation, GKTSDescription *aDescription)
 
void setDataValueInTSByID (uint attrId, GKTimeSerieIndex index, double value, double deviation, GKTSDescription *aDescription=NULL, int reservedSize=0)
 
virtual void setAggregatedValueInTS (const GKColumn *attr, double value, double deviation, GKTSDescription *aDescription=NULL)
 
void setAggregatedValueInTSByID (uint attrId, double value, double deviation, GKTSDescription *aDescription=NULL)
 
virtual void clearDataValueTS (const GKColumn *attr, GKTSDescription *aDescription=NULL)
 
void clearDataValueTSByID (uint attrId, GKTSDescription *aDescription=NULL)
 
virtual int getDataValueInt (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
 
int getDataValueIntByID (uint attrId, const GKContext &context=GKContext::anyContext) const
 
virtual double getDataValueDouble (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
 
double getDataValueDoubleByID (uint attrId, const GKContext &context=GKContext::anyContext) const
 
QString getDataValueString (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
 
QString getDataValueStringByID (uint attrId, const GKContext &context=GKContext::anyContext) const
 
virtual bool getDataValueBool (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
 
bool getDataValueBoolByID (uint attrId, const GKContext &context=GKContext::anyContext) const
 
virtual GKObjectgetDataValueObject (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
 
GKObjectgetDataValueObjectByID (uint attrId, const GKContext &context=GKContext::anyContext) const
 
QDate getDataValueDate (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
 
QDate getDataValueDateByID (uint attrId, const GKContext &context=GKContext::anyContext) const
 
QTime getDataValueTime (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
 
QTime getDataValueTimeByID (uint attrId, const GKContext &context=GKContext::anyContext) const
 
QDateTime getDataValueDateTime (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
 
QDateTime getDataValueDateTimeByID (uint attrId, const GKContext &context=GKContext::anyContext) const
 
GKTimeDuration getDataValueTimeDuration (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
 
GKTimeDuration getDataValueTimeDurationByID (uint attrId, const GKContext &context=GKContext::anyContext) const
 
void removeDataValue (const GKColumn *attr)
 
void removeDataValueByID (uint attrId)
 
const QString & getDescription () const
 
void setDescription (const QString &adescription)
 
const QString & getExternalId () const
 
void setExternalId (const QString &anId)
 
virtual GKObjectDelCmd * getDelCmd ()
 
virtual GKObjectConnectionDelCmd * getDelConnectionCmd (GKObject *target)
 
virtual void nonCommandObjectRemoved (GKObject *)
 
virtual void init ()
 
virtual void setId (uint aid, GKModel *model)
 
uint getId () const
 
QUuid getUUID () const
 
virtual void setName (const QString &aname)
 
const QString & getName () const
 
QString getExtendedId (IdentifierForm form=eIdentifierDefault) const
 
QString getNameOrExtendedId (IdentifierForm form=eIdentifierDefault) const
 
virtual const QString & getTypeName () const
 
virtual QString getTypeExternalName () const
 
const GKObjectgetMaster () const
 
GKTypegetType () const
 
virtual void setType (GKType *atype)
 
bool isA (const GKType *atype) const
 
bool isA (const QString &typeName) const
 
virtual void setModel (GKModel *amodel)
 
GKModelgetModel () const
 
virtual void setLock (GKLockType atype)
 
GKLockType getLock () const
 
virtual bool canBeDeleted () const
 
virtual bool canBeModified () const
 
virtual bool canBeEdited () const
 
GKObjectStatus getStatus () const
 
virtual void setStatus (const GKObjectStatus astatus)
 
void notifyStatusChange ()
 
bool isTemporary () const
 
void setTemporary (bool value)
 
bool isExternal () const
 
void setExternal (bool value)
 
virtual void preferencesChanged ()
 
void removeColumn (GKColumn *column)
 
void resetColumn (GKColumn *column)
 
- Public Member Functions inherited from GKBaseObject
 GKBaseObject ()
 
 if (base)
 
virtual uint getId () const =0
 
virtual const QString & getTypeName () const =0
 
virtual QString getTypeExternalName () const =0
 
virtual const GKObjectgetMaster () const =0
 
virtual const QString & getName () const =0
 
virtual const QString & getExternalId () const =0
 
virtual const QString & getDescription () const =0
 
virtual GKModelgetModel () const =0
 
virtual QVariant * getDataValue (const GKColumn *attr, bool *deleteit, const GKContext &context=GKContext::anyContext) const =0
 
virtual QVariant * getDataValueByID (uint attrId, bool *deleteit, const GKContext &context=GKContext::anyContext) const =0
 
virtual double getDataValueInTS (const GKColumn *attr, GKTimeSerieIndex index, double *deviation=NULL) const =0
 
virtual double getDataValueInTSByID (uint attrId, GKTimeSerieIndex index, double *deviation=NULL) const =0
 
virtual GKTimeSeriegetDataValueTS (const GKColumn *attr) const =0
 
virtual GKTimeSeriegetDataValueTSByID (uint attrId) const =0
 
virtual int getDataValueInt (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0
 
virtual int getDataValueIntByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0
 
virtual double getDataValueDouble (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0
 
virtual double getDataValueDoubleByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0
 
virtual QString getDataValueString (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0
 
virtual QString getDataValueStringByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0
 
virtual bool getDataValueBool (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0
 
virtual bool getDataValueBoolByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0
 
virtual GKObjectgetDataValueObject (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0
 
virtual GKObjectgetDataValueObjectByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0
 
virtual QDate getDataValueDate (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0
 
virtual QDate getDataValueDateByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0
 
virtual QTime getDataValueTime (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0
 
virtual QTime getDataValueTimeByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0
 
virtual QDateTime getDataValueDateTime (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0
 
virtual QDateTime getDataValueDateTimeByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0
 
virtual GKTimeDuration getDataValueTimeDuration (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0
 
virtual GKTimeDuration getDataValueTimeDurationByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0
 

Additional Inherited Members

- Public Types inherited from GKGeoObject
enum  GKGeoContainer { eNothing = 0 , ePartially = 1 , eTotally = 2 }
 
- Public Types inherited from GKObject
enum  IdentifierFormFlag {
  eIdentifierDefault , eIdentifierId , eIdentifierName , eIdentifierExternalId ,
  eIdentifierTypeExternalName , eIdentifierDescription , eIdentifierStandard , eIdentifierStandardWithType ,
  eIdentifierAll
}
 
enum  GKLockType { eNone , eModification , eDelete , eModificationDelete }
 
enum  GKObjectStatus { eNew , eSaved , eModified , eDeleted }
 
typedef QFlags< GKObject::IdentifierFormFlagIdentifierForm
 
- Public Attributes inherited from GKBaseObject
ConvertToSubClassCode Py_BEGIN_ALLOW_THREADS GKBaseObjectbase = (GKBaseObject*)sipCpp
 
 sipType = 0
 
- Static Public Attributes inherited from GKGeoObject
static uint markAtt
 
static uint altitudeAtt
 
static uint numberOfConnectionsAtt
 
static uint layerAtt
 
- Static Public Attributes inherited from GKObject
static uint typeNameAtt
 
static uint typeExternalNameAtt
 
static uint revisedAtt
 
- Static Public Attributes inherited from GKBaseObject
Py_END_ALLOW_THREADS static End uint idAtt
 
static uint nameAtt
 
static uint externalIdAtt
 
static uint descriptionAtt
 

Constructor & Destructor Documentation

◆ GKPolyline()

GKPolyline::GKPolyline ( )

Member Function Documentation

◆ add()

void GKPolyline::add ( const GKPoints ps)

Add points at the end of this polyline.

◆ addPoint()

virtual void GKPolyline::addPoint ( const GKPoint p)
virtual

Adds a point to the polyline

◆ addPointAt()

virtual void GKPolyline::addPointAt ( int  pos,
const GKPoint p 
)
virtual

Adds a point to the polyline at the desired position

◆ canBeJoined()

virtual bool GKPolyline::canBeJoined ( const GKPolyline pol) const
virtual

Return true if "this" and "pol" can be joined in a single object. In this case if both are polylines.

◆ canPointBeAdded()

virtual bool GKPolyline::canPointBeAdded ( uint  pos) const
virtual

Can a new point at position "pos" be added?

Reimplemented in GKBezierCurve, and GKTurning.

◆ changeDirection()

virtual void GKPolyline::changeDirection ( )
virtual

Changes the direction of this polyline, that is: changes the order of the points so the first one becomes the last one and so on.

Reimplemented in GKBezierCurve, and GKSection.

◆ getBBox()

GKBBox GKPolyline::getBBox ( ) const

Gets the bounding box of this object.

◆ getNbSelPoints()

int GKPolyline::getNbSelPoints ( ) const

Gets the number of the selected points

◆ getPenColor()

virtual const QColor & GKPolyline::getPenColor ( ) const
virtual

Gets the pen color to draw the polyline

Reimplemented in GKPedestrianObstacle.

◆ getPenSize()

float GKPolyline::getPenSize ( ) const

Gets the size of the pen

◆ getPenSizeUnits()

const GK::SizeUnits & GKPolyline::getPenSizeUnits ( ) const

Gets the pen size units

◆ getPenStyle()

const Qt::PenStyle & GKPolyline::getPenStyle ( ) const

Gets the pen style to draw the polyline

◆ getPoint()

const GKPoint & GKPolyline::getPoint ( uint  at) const

Gets the GKPoint of the polyline at the desired position

◆ getPoints()

const GKPoints & GKPolyline::getPoints ( ) const

Get the points that define the polyline in a vector of GKPoint. Note that the points returned cannot be modified as they are a constant reference. To modify them use a code similar to the following one:

points = s.getPoints() pointPosition = 0 for point in points: point.set(newXValue, newYValue, newZValue) s.setPoint( pointPosition, point ) pointPosition = pointPosition + 1

◆ getSlope()

GKCoord GKPolyline::getSlope ( int  segmentPos) const

It returns the slope for the segment 'segmentPos' that is, between point at 'segmentPos' and point at 'segmentPos+1'

◆ isPointSelected()

bool GKPolyline::isPointSelected ( uint  p) const

Returns true if the desired point is selected. Return false if the desired point is not selected

◆ join()

virtual void GKPolyline::join ( const GKPolyline pol,
bool  atStart 
)
virtual

Add "pol" information to this polyline either at the beginning (atStart = true) or at the end (atStart = false). Note that pol will not be moified and/or removed.

Reimplemented in GKBezierCurve, and GKSection.

◆ length2D()

virtual GKCoord GKPolyline::length2D ( ) const
virtual

Returns the length of the polyline in 2D

◆ length3D()

virtual GKCoord GKPolyline::length3D ( ) const
virtual

Returns the length of the polyline in 3D

Reimplemented in GKSuperNodeTrajectory.

◆ nbPoints()

uint GKPolyline::nbPoints ( ) const

Gets the number of points in the polyline

◆ prepend()

void GKPolyline::prepend ( const GKPoints ps)

Add points at the beginning of this polyline.

◆ removePoint()

virtual void GKPolyline::removePoint ( uint  pos)
virtual

Removes the desired point in the polyline

Reimplemented in GKBezierCurve, and GKSection.

◆ removePoints()

virtual void GKPolyline::removePoints ( uint  nbPoints,
bool  atStart 
)
virtual

Removes nbPoints from this polyline either at the beginning (atStart = true) or at the end (atStart = false).

Reimplemented in GKSection.

◆ selectAllPoints()

void GKPolyline::selectAllPoints ( )

Selects all the points contained in the polyline

◆ setPenColor()

void GKPolyline::setPenColor ( const QColor &  color)

Sets the pen color to draw the polyline

◆ setPenSize()

void GKPolyline::setPenSize ( float  size)

Sets the size of the pen

◆ setPenSizeUnits()

void GKPolyline::setPenSizeUnits ( const GK::SizeUnits units)

Sets the pen size units

◆ setPenStyle()

void GKPolyline::setPenStyle ( const Qt::PenStyle &  astyle)

Sets the pen style to draw the polyline

◆ setPoint()

void GKPolyline::setPoint ( uint  at,
const GKPoint p 
)

Sets the values of a point in a desired position

◆ setPoints()

virtual void GKPolyline::setPoints ( const GKPoints ps)
virtual

Constructs the polyline using the given GKPoints as the new definition points

Reimplemented in GKExtrudedPolygon.

◆ setPointSelected()

void GKPolyline::setPointSelected ( uint  p,
bool  value 
)

Changes the selection status of a desired point

◆ unselectAllPoints()

void GKPolyline::unselectAllPoints ( )

Unselects all the points contained in the polyline

© Aimsun SLU
Aimsun ®