Unigine.WorldExternBase Class

WorldExternBase Class

Members

---

int GetClassID ( ) #

Returns a unique class ID.

Return value

Unique class ID.

Node GetNode ( ) #

Returns the Node smart pointer.

Return value

Node smart pointer.

WorldExtern GetWorldExtern ( ) #

Returns the WorldExtern smart pointer.

Return value

WorldExtern smart pointer.

int LoadWorld ( Xml xml ) #

Loads a world state from the Xml.

Arguments

• Xml xml - Xml smart pointer.

Return value

1 if the world state was successfully loaded; otherwise, 0.

void PreRender ( float ifps ) #

Pre-render function, i.e. after the update() and before the render() function.

Arguments

• float ifps - Inverse FPS value.

void RenderHandler ( ) #

Renders the handler for the external world.

void RenderVisualizer ( ) #

Renders the visualizer.

int RestoreState ( Stream stream ) #

Restores a world state from the stream.

Arguments

• Stream stream - Stream smart pointer.

Return value

1 if the world state was successfully restored; otherwise, 0.

int SaveState ( Stream stream ) #

Saves a world state into the stream.

Arguments

• Stream stream - Stream smart pointer.

Return value

1 if the world state was successfully saved; otherwise, 0.

int SaveWorld ( Xml xml ) #

Saves a world state into the Xml.

Arguments

• Xml xml - Xml smart pointer.

Return value

1 if the world state was successfully saved; otherwise, 0.

void Update ( float ifps ) #

Update function. It is called when the node is visible.

Arguments

• float ifps - Inverse FPS value.

void UpdateEnabled ( ) #

Updates enabled.

void UpdatePosition ( ) #

Updates a position of the external world.

void UpdateTransform ( ) #

Updates transformation matrix of the external world.

void SetUpdateDistanceLimit ( float distance ) #

Sets the distance from the camera within which the external world should be updated.

Arguments

• float distance - Distance from the camera within which the external world should be updated (in units).

float GetUpdateDistanceLimit ( ) #

Returns the distance from the camera within which the external world should be updated.

Return value

Distance from the camera within which the external world should be updated (in units).

void SetUpdate ( bool enabled ) #

Sets a value indicating if the external world should be constantly updated each frame, regardless of the update distance.

Arguments

• bool enabled - true to enable forced updating for the external world; false - to disable forced updating and take the update distance into account.

bool IsUpdate ( ) #

Returns a value indicating if the external world should be constantly updated each frame, regardless of the update distance.

Return value

true if the external world is constantly updated each frame; otherwise, false