GKPedestrianPolygonObstacleNewCmd Class Reference

Inheritance diagram for GKPedestrianPolygonObstacleNewCmd:

Public Member Functions
	GKPedestrianPolygonObstacleNewCmd ()
void	setRemovePreviousObstacles (bool value)
void	setPedestrianArea (GKPedestrianArea *)
void	setOriginObject (GKGeoObject *object)
void	setPoints (const GKPoints &somePoints)
GKCommandReport *	init (GKModel *amodel)
void	doit ()
void	undoit ()
Public Member Functions inherited from GKCommand
	if (base)
Py_END_ALLOW_THREADS End	GKCommand ()
void	setName (const QString &)
const QString &	getName () const
void	setModel (GKModel *)
GKModel *	getModel () const
virtual GKCommandReport *	init (GKModel *)
virtual bool	isEqual (GKCommand *) const
virtual void	merge (GKCommand *)
virtual void	doit ()=0
virtual void	undoit ()=0
void	setUndoable (bool)
bool	isUndoable () const
bool	isDone () const
virtual void	setDone (bool)
virtual void	commandToBeDone ()
virtual void	commandDone ()
virtual void	commandToBeUndone ()
virtual void	commandUndone ()
virtual GKObject *	createdObject () const
virtual bool	createdObjectRequiresEdition () const
virtual QVector< int >	getTargets () const

Additional Inherited Members
Public Attributes inherited from GKCommand
ConvertToSubClassCode Py_BEGIN_ALLOW_THREADS GKCommand *	base = (GKCommand*)sipCpp
	sipType = 0

Detailed Description

Creates a Pedestrian Polygon Obstacle. The correct way to create this command is to use the function:

GKCommand * createNewCmd( GKType * type ) const;

from the GKModel class.

See also

GKModel::createNewCmd

Once created, and in order to do it use the function:

GKCommandReport * addCommand( GKCommand * aCommand );

from the GKCommander class.

See also

GKCommander::addCommand

A sample code for creating a new Pedestrian Polygon Obstacle would look like:

cmd = model.createNewCmd( model.getType( "GKPedestrianPolygonObstacle" ))
cmd.setRemovePreviousObstacles( boolean )
cmd.setPedestrianArea( pedestrianArea )
cmd.setOriginObject( originObject )
cmd.setPoints( points )
cmd.init( model )
model.getCommander().addCommand( cmd )
res = cmd.createdObject()

Constructor & Destructor Documentation

GKPedestrianPolygonObstacleNewCmd()

GKPedestrianPolygonObstacleNewCmd::GKPedestrianPolygonObstacleNewCmd

(

)

Member Function Documentation

doit()

void GKPedestrianPolygonObstacleNewCmd::doit ( )

virtual

Do not use this function. Available just for compatibility issues.

Implements GKCommand.

init()

GKCommandReport * GKPedestrianPolygonObstacleNewCmd::init ( GKModel *  )

virtual

Initializes the command and returns NULL if the command can be executed, othewise it returns information about why the command cannot be executed. This method is called by GKCommander when the command is added to it (GKCommander::add) and before it is executed.

Reimplemented from GKCommand.

setOriginObject()

void GKPedestrianPolygonObstacleNewCmd::setOriginObject

(

GKGeoObject *

object

)

setPedestrianArea()

void GKPedestrianPolygonObstacleNewCmd::setPedestrianArea

(

GKPedestrianArea *

)

setPoints()

void GKPedestrianPolygonObstacleNewCmd::setPoints

(

const GKPoints &

somePoints

)

setRemovePreviousObstacles()

void GKPedestrianPolygonObstacleNewCmd::setRemovePreviousObstacles

(

bool

value

)

undoit()

void GKPedestrianPolygonObstacleNewCmd::undoit ( )

virtual

Do not use this function. Available just for compatibility issues.

Implements GKCommand.