#include <CommandEntityToPositions.h>

Inheritance diagram for conscience_core::bridging::commands::environment_entities::CommandEntityToPositions:

Public Member Functions
	CommandEntityToPositions (const vector< const CscPoint3d * > &targetPositions, ptr< CscEntityReflexion > entityReflexion, CscArea3d zone=nullptr, optional< double > distanceWithObjectAutorized={}, optional< int > matrixSize={}, const CscPoint3d startPosition=nullptr, optional< bool > useGnssCoordinates={}, const vector< string > *placeModelIdsToIgnore=nullptr, optional< bool > resumeAtClosestPosition={})

	~CommandEntityToPositions () override

Public Member Functions inherited from conscience_core::bridging::commands::CscCommand
const CscCommandExecutionResult *	_execute (CscEnvironmentSimulator &environmentSimulator)

template<class TResult = CscCommandExecutionResult>
const TResult *	execute (CscEnvironmentSimulator &environmentSimulator)

const CommandTypeId &	getTypeId () const

virtual	~CscCommand ()

void	setOriginalCommandString (string command)

Static Public Attributes
static const CommandTypeId	COMMAND_ID = "ENTITY_TO_POSITIONS"

Protected Member Functions
const CscCommandExecutionResultSequence *	doExecute (CscEnvironmentSimulator &environmentSimulator) override

ptr< CscEntityReflexion >	getEntityReflexion () const override

Protected Member Functions inherited from conscience_core::bridging::commands::CscCommand
	CscCommand (const CommandTypeId &typeId)

const CscCommandExecutionResultNone *	resultNone ()

const CscCommandExecutionResultSequence *	resultSequence (CscSequence *sequence, const string &entitySerialNumber, bool doNotPlay=false)

const CscCommandExecutionResultFile *	resultFile (const fs::path &resultingFilePath)

template<class TResult >
const CscCommandExecutionResultObject< TResult > *	resultObject (TResult *result)

const CscWorldElementId	getEntityId () const

Additional Inherited Members
Public Types inherited from conscience_core::bridging::commands::CscCommand
typedef function< void(CscCommand *command)>	CommandExecutedListener

Static Public Member Functions inherited from conscience_core::bridging::commands::CscCommand
static void	addCommandExecutedListener (CommandExecutedListener listener)

Protected Attributes inherited from conscience_core::bridging::commands::CscCommand
const CommandTypeId	typeId

optional< string >	originalCommandString = {}

Detailed Description

The EntityToPositions command generates a sequence of positions that the entity must follow to go through all requested positions. The shortest path is generated by taking into account the objects in the scene and the scene itself.

Constructor & Destructor Documentation

◆ CommandEntityToPositions()

conscience_core::bridging::commands::environment_entities::CommandEntityToPositions::CommandEntityToPositions	(	const vector< const CscPoint3d * > &	targetPositions,
		ptr< CscEntityReflexion >	entityReflexion,
		CscArea3d *	zone = `nullptr`,
		optional< double >	distanceWithObjectAutorized = `{}`,
		optional< int >	matrixSize = `{}`,
		const CscPoint3d *	startPosition = `nullptr`,
		optional< bool >	useGnssCoordinates = `{}`,
		const vector< string > *	placeModelIdsToIgnore = `nullptr`,
		optional< bool >	resumeAtClosestPosition = `{}`
	)

Parameters

targetPositions	The command takes as input a list of positions through which the entity must pass
zone	the analysis area for path generation
distanceWithObjectAutorized	the allowable distance with objects and the scene
matrixSize	the size of the pathfinding matrix.
startPosition	You can set too set the start position.
resumeAtClosestPosition	if resumeAtClosestPosition is true, will start at position index which is closest to startPosition (which is entity's position by default)

◆ ~CommandEntityToPositions()

conscience_core::bridging::commands::environment_entities::CommandEntityToPositions::~CommandEntityToPositions ( )

override

Member Function Documentation

◆ doExecute()

const CscCommandExecutionResultSequence * conscience_core::bridging::commands::environment_entities::CommandEntityToPositions::doExecute ( CscEnvironmentSimulator & environmentSimulator )

overrideprotectedvirtual

Implements conscience_core::bridging::commands::CscCommand.

◆ getEntityReflexion()

ptr< CscEntityReflexion > conscience_core::bridging::commands::environment_entities::CommandEntityToPositions::getEntityReflexion ( ) const

overrideprotectedvirtual

return entity reflexion if this command applies on an entityReflexion, otherwise return nullptr

Implements conscience_core::bridging::commands::CscCommand.

Member Data Documentation

◆ COMMAND_ID

const CommandTypeId conscience_core::bridging::commands::environment_entities::CommandEntityToPositions::COMMAND_ID = "ENTITY_TO_POSITIONS"

inlinestatic

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

Bridging/EnvironmentInteractionCommands/CommandEntityToPositions.h
Bridging/EnvironmentInteractionCommands/CommandEntityToPositions.cpp

Conscience Core

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members