Unigine::Plugin Class

Методы:

Имя	Описание View: Sort by:
get_data	Returns the plugin data.
get_name	Returns the name of the plugin.
get_order	Returns the execution order of the plugin.
getCompilationFlags	Returns the Unigine compilation flags.
updatePhysics	Engine calls this function before updating each physics frame.
gui	Engine calls this function before gui each render frame for the specified engine window viewport.
init	Engine calls this function on plugin initialization.
loadWorld	Engine calls this function on world loading.
render	Engine calls this function before rendering each render frame for the specified Engine window viewport.
saveState	Engine calls this function on world saving.
restoreState	Engine calls this function on world restoring.
saveWorld	Engine calls this function on world saving.
shutdown	Engine calls this function on plugin shutdown.
swap	Engine calls this function before swapping each render frame.
update	Engine calls this function before updating each render frame.
postUpdate	Engine calls this function after updating each render frame.

Plugin Class

Members

virtual void * get_data ( ) #

Returns the plugin data.

Return value

Plugin data.

virtual const char * get_name ( ) #

Returns the name of the plugin.

Return value

Plugin name.

int get_order ( ) #

Returns the execution order of the plugin. Each plugin has its execution order, which determines the sequence in which plugin’s functions (update / postUpdate / render / shutdown) will be executed. The only exception is the init function as it is called just after loading the plugin.

Notice

Remember, when writing your own plugin, that requires interaction with other ones, specifying correct order value is required to avoid issues and ensure proper execution sequence. If in your case the order doesn't matter, set the default 0 value.

Return value

Plugin execution order.

virtual int getCompilationFlags ( ) const#

Returns the Unigine compilation flags.

Return value

Unigine compilation flags.

virtual void updatePhysics ( ) #

Engine calls this function before updating each physics frame.

virtual void gui ( EngineWindowViewportPtr& window ) #

Engine calls this function before gui each render frame for the specified engine window viewport.

Arguments

EngineWindowViewportPtr& window - Target Engine window viewport.

virtual int init ( ) #

Engine calls this function on plugin initialization.

Return value

true on success, or false if an error has occurred.

virtual bool loadWorld ( const XmlPtr & xml ) #

Engine calls this function on world loading.

Arguments

const XmlPtr & xml - Xml instance from which the data is to be loaded.

Return value

true on success; otherwise, false.

virtual void render ( const EngineWindowViewportPtr& window ) #

Engine calls this function before rendering each render frame for the specified Engine window viewport.

Arguments

const EngineWindowViewportPtr& window - Target Engine window viewport.

virtual bool saveState ( const StreamPtr & stream ) #

Engine calls this function on world saving.

Example using saveState() and restoreState() methods:

Source code (C++)

class MyPlugin: public Plugin
{
public:
	MyPlugin() {}
	virtual ~MyPlugin() {}

	const char *get_name() override { return "MyPlugin"; }

	
	// override method save/restore state
	virtual int saveState(const StreamPtr &stream) override { stream->writeInt(getValue()); return 1;}
	virtual int restoreState(const StreamPtr &stream) override { setValue(stream->readInt());  return 1;}
	
	void setValue(int v) { some_value = v; }
	int getValue() const { return some_value; }
	
private:
	int some_value = 0;
};

	//...
	
	MyPlugin * plugin = /*...*/;
	plugin->setValue(5);
	int v1 = plugin->getValue(); // v1 = 5;
	
	
	// save state
	BlobPtr blob_state = Blob::create();
	plugin->saveState(blob_state);
	
	// change state
	plugin->setValue(10);
	int v2 = plugin->getValue(); // v2 = 10;
	
	// restore state
	blob_state->seekSet(0);
	plugin->restoreState(blob_state);
	
	
	int v3 = plugin->getValue(); // v3 = 5; 
						
	//...

Arguments

const StreamPtr & stream - Stream, to which the current state is to be saved.

Return value

true on success; otherwise, false.

virtual int restoreState ( const StreamPtr & stream ) #

Engine calls this function on world restoring.

Example using saveState() and restoreState() methods:

Source code (C++)

class MyPlugin: public Plugin
{
public:
	MyPlugin() {}
	virtual ~MyPlugin() {}

	const char *get_name() override { return "MyPlugin"; }

	
	// override method save/restore state
	virtual int saveState(const StreamPtr &stream) override { stream->writeInt(getValue()); return 1;}
	virtual int restoreState(const StreamPtr &stream) override { setValue(stream->readInt());  return 1;}
	
	void setValue(int v) { some_value = v; }
	int getValue() const { return some_value; }
	
private:
	int some_value = 0;
};

	//...
	
	MyPlugin * plugin = /*...*/;
	plugin->setValue(5);
	int v1 = plugin->getValue(); // v1 = 5;
	
	
	// save state
	BlobPtr blob_state = Blob::create();
	plugin->saveState(blob_state);
	
	// change state
	plugin->setValue(10);
	int v2 = plugin->getValue(); // v2 = 10;
	
	// restore state
	blob_state->seekSet(0);
	plugin->restoreState(blob_state);
	
	
	int v3 = plugin->getValue(); // v3 = 5; 
						
	//...

Arguments

const StreamPtr & stream - Stream, from which the previously saved state is to be restored.

Return value

Returns 1 on success, or 0 if an error has occurred.

virtual int saveWorld ( const XmlPtr & xml ) #

Engine calls this function on world saving.

Arguments

const XmlPtr & xml - Xml instance to which the data is to be saved.

Return value

Returns 1 on success, or 0 if an error has occurred.

virtual int shutdown ( ) #

Engine calls this function on plugin shutdown.

Return value

Returns 1 on success, or 0 if an error has occurred.

virtual void swap ( ) #

Engine calls this function before swapping each render frame.

virtual void update ( ) #

Engine calls this function before updating each render frame.

void postUpdate ( ) #

Engine calls this function after updating each render frame.

Last update: 19.04.2024

Помогите сделать статью лучше

Была ли эта статья полезной?

Сообщить о проблеме в этой статье

(или выберите слово/фразу и нажмите Ctrl+Enter

Unigine::Plugin Class

In This Article:

Методы:

Plugin Class

Members

virtual void * get_data ( ) #

Return value

virtual const char * get_name ( ) #

Return value

int get_order ( ) #

Return value

virtual int getCompilationFlags ( ) const#

Return value

virtual void updatePhysics ( ) #

virtual void gui ( EngineWindowViewportPtr& window ) #

Arguments

virtual int init ( ) #

Return value

virtual bool loadWorld ( const XmlPtr & xml ) #

Arguments

Return value

virtual void render ( const EngineWindowViewportPtr& window ) #

Arguments

virtual bool saveState ( const StreamPtr & stream ) #

Arguments

Return value

virtual int restoreState ( const StreamPtr & stream ) #

Arguments

Return value

virtual int saveWorld ( const XmlPtr & xml ) #

Arguments

Return value

virtual int shutdown ( ) #

Return value

virtual void swap ( ) #

virtual void update ( ) #

void postUpdate ( ) #