Scene Class Reference

Stores scene in a scene graph. More...

#include <Scene.hpp>

Public Member Functions
virtual	~Scene ()
virtual void	Add (Camera *camera)=0
virtual void	Add (Light *light)=0
virtual void	Add (Model *model)=0
virtual void	Remove (SceneGraphNode *node)=0
virtual Camera *	GetNonRTCamera ()=0
virtual Material *	GetMaterial (const char *name)=0
virtual Model *	GetModel (const char *name)=0
virtual std::list< std::pair< Model *, std::list< std::string > > >	GetColliders (int screenX, int screenY, CollisionTest collisionTest, float maxDepth) const =0
virtual std::list< std::pair< Model *, std::list< std::string > > >	GetColliders (const Vec3 &aabbMin, const Vec3 &aabbMax, CollisionTest collisionTest) const =0
virtual bool	LoadFromFile (const char *path)=0
virtual bool	SaveToFile (const char *path)=0
virtual SceneGraphNode &	RootNode ()=0
virtual void	SetSkybox (const Texture *cubeMap)=0
virtual void	OnNodeAdded (SceneGraphNode *node)=0

Detailed Description

Stores scene in a scene graph.

Constructor & Destructor Documentation

~Scene()

virtual Scene::~Scene ( )

inlinevirtual

Destructor.

Member Function Documentation

Add() [1/3]

virtual void Scene::Add ( Camera *  camera )

pure virtual

Parameters

camera

Camera.

Add() [2/3]

virtual void Scene::Add ( Light *  light )

pure virtual

Parameters

light

Light.

Add() [3/3]

virtual void Scene::Add ( Model *  model )

pure virtual

Parameters

model

Model.

GetColliders() [1/2]

virtual std::list< std::pair< Model*, std::list< std::string > > > Scene::GetColliders ( const Vec3 &  aabbMin, const Vec3 &  aabbMax, CollisionTest  collisionTest  ) const

pure virtual

Gets colliders for an AABB. Note that collision with a model's AABB does not necessarily mean that any of the meshes were included in the collision.

Parameters

aabbMin	AABB's min value in world-space.
aabbMax	AABB's max value in world-space.
collisionTest	Collision test to perform.

Returns

List of (Model, collided mesh names)

GetColliders() [2/2]

virtual std::list< std::pair< Model*, std::list< std::string > > > Scene::GetColliders ( int  screenX, int  screenY, CollisionTest  collisionTest, float  maxDepth  ) const

pure virtual

Gets colliders for a ray shot through a screen point. The first object's first mesh is the closest.

Parameters

screenX	Screen x coordinate in pixels.
screenY	Screen y coordinate in pixels.
collisionTest	Collision test to perform.
maxDepth	Maximum depth where collisions are tested.

Returns

List of (Model, collided mesh names)

GetMaterial()

virtual Material* Scene::GetMaterial ( const char *  name )

pure virtual

Finds a material that was loaded from a .scene file.

Parameters

name	Material's name.

Returns

Material or null if Scene does not contain a Material named name.

GetModel()

virtual Model* Scene::GetModel ( const char *  name )

pure virtual

Finds a model.

Parameters

name	Model's name.

Returns

Model or null if Scene does not contain a Model named name.

GetNonRTCamera()

virtual Camera* Scene::GetNonRTCamera ( )

pure virtual

Returns

The camera that is not set to render into a texture or nullptr if there is no such camera.

LoadFromFile()

virtual bool Scene::LoadFromFile ( const char *  path )

pure virtual

Loads a scene from a text file. Does not empty current scene contents.

Parameters

path	.scene file.

Returns

True on success, false on failure. Failure reason is printed into console.

OnNodeAdded()

virtual void Scene::OnNodeAdded ( SceneGraphNode *  node )

pure virtual

Called automatically when a node is added into scene to update Scene's internal representation.

Parameters

node

Node.

Remove()

virtual void Scene::Remove ( SceneGraphNode *  node )

pure virtual

Parameters

node	Node to be removed from the scene graph.

RootNode()

virtual SceneGraphNode& Scene::RootNode ( )

pure virtual

Returns

Root node.

SaveToFile()

virtual bool Scene::SaveToFile ( const char *  path )

pure virtual

Saves the scene into an ascii file.

Parameters

path	.scene file.

Returns

True, if succeeded, false otherwise.

SetSkybox()

virtual void Scene::SetSkybox ( const Texture *  cubeMap )

pure virtual

Parameters

cubeMap

Cube map that's used for skybox cube mesh.

---

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

• /home/glaze/Documents/src/Aether3D_2013/Include/Scene.hpp