Cogs::Core::EchoSounder::EchoSounderExtension Struct Reference

Inheritance diagram for Cogs::Core::EchoSounder::EchoSounderExtension:

Public Member Functions
bool	initializeStatic () override
	Initialize extension statically.
bool	initialize (Context *context) override
	Initialize extension for the given context.
void	cleanup (Context *context) override
	Cleanup context bound extension content.
void *	getSymbolPointer (const char *symbol) const override
	Get pointer to symbol defined by extension.
const char *	getExtensionKey () const override
	Get the extensions unique key, used to check for extension presence and retrieve extension specific data from the context.
Public Member Functions inherited from Cogs::Core::Extension
virtual bool	initializeStatic ()
	Initialize extension statically.
virtual bool	initialize (Context *)
	Initialize extension for the given context.
virtual void	cleanup (Context *)
	Cleanup context bound extension content.
virtual const char *	getExtensionKey () const =0
	Get the extensions unique key, used to check for extension presence and retrieve extension specific data from the context.
virtual void *	getSymbolPointer (const char *) const
	Get pointer to symbol defined by extension.
virtual const void *	getPublicAPI () const
	Retrieve a pointer to a struct containing all publicly available function pointers.

Detailed Description

Definition at line 296 of file EchoSounderExtension.cpp.

Constructor & Destructor Documentation

EchoSounderExtension()

Cogs::Core::EchoSounder::EchoSounderExtension::EchoSounderExtension ( )

inline

Definition at line 298 of file EchoSounderExtension.cpp.

Member Function Documentation

cleanup()

void Cogs::Core::EchoSounder::EchoSounderExtension::cleanup ( Context *  )

overridevirtual

Cleanup context bound extension content.

Parameters

context

Context currently being cleaned up.

Reimplemented from Cogs::Core::Extension.

Definition at line 662 of file EchoSounderExtension.cpp.

getExtensionKey()

const char * Cogs::Core::EchoSounder::EchoSounderExtension::getExtensionKey ( ) const

inlineoverridevirtual

Get the extensions unique key, used to check for extension presence and retrieve extension specific data from the context.

Returns

Pointer to a null-terminated string containing the name of the extension.

Implements Cogs::Core::Extension.

Definition at line 329 of file EchoSounderExtension.cpp.

getSymbolPointer()

void * Cogs::Core::EchoSounder::EchoSounderExtension::getSymbolPointer ( const char *  ) const

inlineoverridevirtual

Get pointer to symbol defined by extension.

Reimplemented from Cogs::Core::Extension.

Definition at line 304 of file EchoSounderExtension.cpp.

initialize()

bool Cogs::Core::EchoSounder::EchoSounderExtension::initialize ( Context *  )

overridevirtual

Initialize extension for the given context.

Override this method to provide context bound initialization. This can for example be registering entity definitions in the entity store, creating component systems in the context, or other per context tasks.

Parameters

context

Context currently being initialized.

Reimplemented from Cogs::Core::Extension.

Definition at line 431 of file EchoSounderExtension.cpp.

References Cogs::Core::SystemPriority::Geometry, Cogs::Core::SystemPriority::PreDynamicComponents, Cogs::Core::SystemPriority::PreGeometry, Cogs::Core::Context::registerDynamicComponentType(), Cogs::Core::Context::resourceStore, Cogs::Core::Context::store, and Cogs::Core::Context::variables.

initializeStatic()

bool Cogs::Core::EchoSounder::EchoSounderExtension::initializeStatic ( )

overridevirtual

Initialize extension statically.

Override this method to provide static initialization code. This can for example be filling data tables for later use, registering types in the static type system or other tasks that are only necessary to perform once per application run.

Reimplemented from Cogs::Core::Extension.

Definition at line 414 of file EchoSounderExtension.cpp.

---

The documentation for this struct was generated from the following file:

• Extensions/EchoSounder/Source/EchoSounderExtension.cpp