conscience_core::bridging::commands::CommandObjectsDetect Class Reference

#include <CommandObjectsDetect.h>

Inheritance diagram for conscience_core::bridging::commands::CommandObjectsDetect:

Public Member Functions
	CommandObjectsDetect (ptr< CscEntityReflexion > entityReflexion, const vector< DetectableObjectTypes > &types)
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 = "OBJECTS_DETECT"

Protected Member Functions
const CscCommandExecutionResultNone *	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

Protected Attributes
ptr< CscEntityReflexion >	entityReflexion
const vector< DetectableObjectTypes >	types
std::unique_ptr< CscLogger >	logger = CscLogger::getForCategory("CommandObjectsDetect")
Protected Attributes inherited from conscience_core::bridging::commands::CscCommand
const CommandTypeId	typeId
optional< string >	originalCommandString = {}

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)

Detailed Description

This command will make entity start to detect objects around it. If entity sees something, it will inject it into the environment.

Detection can be stopped at any time using another command : DETECT_STOP

Note : if a detection is already running, it will be stopped.

Constructor & Destructor Documentation

CommandObjectsDetect()

conscience_core::bridging::commands::CommandObjectsDetect::CommandObjectsDetect	(	ptr< CscEntityReflexion >	entityReflexion,
		const vector< DetectableObjectTypes > &	types
	)

Parameters

entityReflexion	entity which will start to detect objects
types	list of object types to be detected by entity. Empty list = detect all

Member Function Documentation

doExecute()

const CscCommandExecutionResultNone * conscience_core::bridging::commands::CommandObjectsDetect::doExecute ( CscEnvironmentSimulator &  environmentSimulator )

overrideprotectedvirtual

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

getEntityReflexion()

ptr< CscEntityReflexion > conscience_core::bridging::commands::CommandObjectsDetect::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::CommandObjectsDetect::COMMAND_ID = "OBJECTS_DETECT"

inlinestatic

entityReflexion

ptr<CscEntityReflexion> conscience_core::bridging::commands::CommandObjectsDetect::entityReflexion

protected

logger

std::unique_ptr<CscLogger> conscience_core::bridging::commands::CommandObjectsDetect::logger = CscLogger::getForCategory("CommandObjectsDetect")

protected

types

const vector<DetectableObjectTypes> conscience_core::bridging::commands::CommandObjectsDetect::types

protected

---

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

• Bridging/EnvironmentInteractionCommands/CommandObjectsDetect.h
• Bridging/EnvironmentInteractionCommands/CommandObjectsDetect.cpp