#include <environmentEntitiesCommands.h>

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

Public Member Functions
	CommandEntitiesGet (const EntitiesGetFiltersCommandDataType *filters=nullptr)

	~CommandEntitiesGet () 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 = "ENTITIES_GET"

Protected Member Functions
const CscCommandExecutionResultList< WorldEntityCommandDataType > *	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 command returns the list of WorldEntities loaded into the scene. The result can be refined by filtering with an area, filtering by ids, or filtering by model ids. Returns a list of general data about filtered WorldEntities.

Constructor & Destructor Documentation

◆ CommandEntitiesGet()

conscience_core::bridging::commands::environment_entities::CommandEntitiesGet::CommandEntitiesGet ( const EntitiesGetFiltersCommandDataType * filters = nullptr )

◆ ~CommandEntitiesGet()

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

override

Member Function Documentation

◆ doExecute()

const CscCommandExecutionResultList< WorldEntityCommandDataType > * conscience_core::bridging::commands::environment_entities::CommandEntitiesGet::doExecute ( CscEnvironmentSimulator & environmentSimulator )

overrideprotectedvirtual

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

◆ getEntityReflexion()

ptr< CscEntityReflexion > conscience_core::bridging::commands::environment_entities::CommandEntitiesGet::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::CommandEntitiesGet::COMMAND_ID = "ENTITIES_GET"

inlinestatic

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

Bridging/EnvironmentInteractionCommands/environmentEntitiesCommands.h
Bridging/EnvironmentInteractionCommands/environmentEntitiesCommands.cpp

Conscience Core

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members