This class contains a set of objects that make up a 3D scene. More...

#include <OvglScene.h>

Public Member Functions
Light *	CreateLight (Matrix44 matirx, Vector4 color)
Camera *	CreateCamera (Matrix44 *view_matrix)
Actor *	CreateActor (Mesh mesh, float radius, float height, Matrix44 matirx)
Prop *	CreateProp (Mesh mesh, Matrix44 matrix)
Object *	CreateObject (Mesh mesh, Matrix44 matrix)
Emitter *	CreateEmitter (Matrix44 *matrix)
void	Update (DWORD update_time)
void	Save (const std::string &file, DWORD flags)
void	Load (const std::string &file, DWORD flags)
void	Import_FBX (const std::string &file, DWORD flags)
void	Release ()
Public Attributes
Instance *	Inst
NxScene *	physics_scene
std::vector< Object * >	objects
std::vector< Light * >	lights
std::vector< Camera * >	cameras
std::vector< Prop * >	props
std::vector< Actor * >	actors
std::vector< Emitter * >	emitters

Detailed Description

This class contains a set of objects that make up a 3D scene.

Scenes contain all the 3D objects that you will see on the screen such as lights, cameras, props, and actors. They also maintain the physics scene and objects.

Member Function Documentation

Actor* Ovgl::Scene::CreateActor	(	Mesh *	mesh,
		float	radius,
		float	height,
		Matrix44 *	matirx
	)

This function adds a Ovgl::Actor to the scene.

Parameters:

mesh	The mesh object that will be displayed for the actor.
radius	The radius of the actor's capsule within the physics scene which is the distance at which a character comes in contact with objects in the character's vertical plane.
height	The hieght of the actor's capsule within the physics scene which is the distance at which a character comes in contact with objects in the character's horizontal plane.
matrix	The matrix which defines the the starting pose of the actor.

Camera* Ovgl::Scene::CreateCamera ( Matrix44 * view_matrix )

This function adds a Ovgl::Camera to the scene.

Parameters:

matrix The matrix which defines the the starting pose of the camera.

Emitter* Ovgl::Scene::CreateEmitter ( Matrix44 * matrix )

This function adds a Ovgl::Emitter to the scene.

Parameters:

matrix The matrix which defines the starting pose of the emitter.

Light* Ovgl::Scene::CreateLight	(	Matrix44 *	matirx,
		Vector4 *	color
	)

This function adds a Ovgl::Light to the scene.

Parameters:

matrix	The matrix which defines the the starting pose of the light.
color	The color of the light.
type	This option can be used to specify what type of light to emit. There are three types Point Light, Spot Light, and a Directional Light.

Object* Ovgl::Scene::CreateObject	(	Mesh *	mesh,
		Matrix44 *	matrix
	)

This function adds a Ovgl::Prop to the scene.

Parameters:

mesh	The mesh that will be displayed for the object.
matrix	The matrix which defines the pose of the object.

Prop* Ovgl::Scene::CreateProp	(	Mesh *	mesh,
		Matrix44 *	matrix
	)

This function adds a Ovgl::Prop to the scene.

Parameters:

mesh	The mesh that will be displayed for the prop.
matrix	The matrix which defines the the starting pose of the prop.

void Ovgl::Scene::Import_FBX	(	const std::string &	file,
		DWORD	flags
	)

This function loads a scene from the FBX format.

Parameters:

file	The file to load.

void Ovgl::Scene::Load	(	const std::string &	file,
		DWORD	flags
	)

This function loads a scene from the engine's native format.

Parameters:

file	The file to load.

void Ovgl::Scene::Release ( )

This function will release control of all memory associated with the scene and any objects within it. It will also remove any reference to it from the Ovgl::Instance.