Cogs::Core::EditorExtension Struct Reference

Inheritance diagram for Cogs::Core::EditorExtension:

Public Member Functions
bool	initialize (Context *context) override
	Initialize extension for the given context.
void	cleanup (Context *context) override
	Cleanup context bound extension content.
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.

Public Attributes
EditorRenderExtension *	renderExtension = nullptr

Detailed Description

Definition at line 44 of file EditorExtension.cpp.

Constructor & Destructor Documentation

EditorExtension()

Cogs::Core::EditorExtension::EditorExtension ( )

inline

Definition at line 46 of file EditorExtension.cpp.

Member Function Documentation

cleanup()

void Cogs::Core::EditorExtension::cleanup ( Context *  )

inlineoverridevirtual

Cleanup context bound extension content.

Parameters

context

Context currently being cleaned up.

Reimplemented from Cogs::Core::Extension.

Definition at line 82 of file EditorExtension.cpp.

References Cogs::Core::Context::renderer, and Cogs::Core::IRenderer::unregisterExtension().

getExtensionKey()

const char * Cogs::Core::EditorExtension::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 89 of file EditorExtension.cpp.

initialize()

bool Cogs::Core::EditorExtension::initialize ( Context *  )

inlineoverridevirtual

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 48 of file EditorExtension.cpp.

References Cogs::Core::Context::engine, Cogs::Core::IRenderer::registerExtension(), Cogs::Core::Context::renderer, and Cogs::Core::Context::resourceStore.

Member Data Documentation

renderExtension

EditorRenderExtension* Cogs::Core::EditorExtension::renderExtension = nullptr

Definition at line 91 of file EditorExtension.cpp.

---

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

• Extensions/Editor/Source/EditorExtension.cpp