com.yogurt3d.core.sceneobjects.Scene

	Property	Defined By
		cameraSet : Vector.<Camera> [read-only] Camera objects added to this IScene instance (including hierarchical ones, children, grand children) in a one dimensional (flattened) vector.	Scene
		children : Vector.<SceneObject> [read-only] Top level children objects contained in this IScene instance	Scene
		lightSet : Vector.<Light> [read-only]	Scene
		objectSet : Vector.<SceneObject> [read-only] All objects added to this IScene instance (including hierarchical ones, children, grand children) in a one dimensional (flattened) vector.	Scene
		postEffects : Vector.<Effect> [read-only]	Scene
		sceneColor : Color	Scene
		skyBox : SkyBox	Scene
		systemID : String [read-only] Automatically assigned id.	EngineObject
		triangleCount : int [read-only]	Scene
		userID : String Identification string can be assigned by developer to identify objects.	EngineObject

	Method	Defined By
		Scene(_sceneTreeManagerDriver:String = SimpleSceneTreeManagerDriver, args:Object = null, _initInternals:Boolean = true)	Scene
		addChild(_value:SceneObject):void Adds given child object into this IScene instance	Scene
		addPostEffect(_effect:Effect):void	Scene
		clearIlluminatorLightIndexes(_scene:IScene, _objectRenderable:SceneObjectRenderable):void	Scene
		clone():IEngineObject Creates new clone object.	EngineObject
		containsChild(_child:SceneObject, _recursive:Boolean = false):Boolean Determines whether the specified SceneObject instance is a child of the IScene instance.	Scene
		dispose():void [override]	Scene
		disposeDeep():void [override]	Scene
		disposeGPU():void [override]	Scene
		getChildBySystemID(_value:String):SceneObject Returns child object that has given systemID.	Scene
		getChildByUserID(_value:String):SceneObject Returns child object that has given userID.	Scene
		getIlluminatorLightIndexes(_scene:IScene, _objectRenderable:SceneObjectRenderable):Vector.<int>	Scene
		getIntersectedLightsByCamera(_camera:Camera):Vector.<Light>	Scene
		getRenderableSet(_camera:Camera):Vector.<SceneObjectRenderable> SceneObjectRenderable objects added to this IScene instance (including hierarchical ones, children, grand children) in a one dimensional (flattened) vector.	Scene
		getRenderableSetLight(_light:Light, _lightIndex:int):Vector.<SceneObjectRenderable>	Scene
		instance():* Removes all external referances and clears internals.	EngineObject
		postRender():void	Scene
		preRender(_activeCamera:Camera):void	Scene
		removeAllEffects():void	Scene
		removeChild(_value:SceneObject):void Removes given child object from this IScene instance	Scene
		removeChildBySystemID(_value:String):void Removes child object that has given systemID from this IScene instance.	Scene
		removeChildByUserID(_value:String):void Removes child object that has given userID from this IScene instance.	Scene
		removePostEffect(_effect:Effect):void	Scene
		renew():void Renews object internals and resets properties of object.	EngineObject
		toString():String Returns a string identifier on this object	EngineObject

	Method	Defined By
		initInternals():void [override]	Scene
		trackObject():void [override]	Scene

	Constant	Defined By
		OCTREE_SCENE : String = OcTreeSceneTreeManagerDriver [static]	Scene
		QUAD_SCENE : String = QuadSceneTreeManagerDriver [static]	Scene
		SIMPLE_SCENE : String = SimpleSceneTreeManagerDriver [static]	Scene

Property Detail

cameraSet

property

cameraSet:Vector.<Camera> [read-only]

Camera objects added to this IScene instance (including hierarchical ones, children, grand children) in a one dimensional (flattened) vector.

Implementation
public function get cameraSet():Vector.<Camera>

children

property

children:Vector.<SceneObject> [read-only]

Top level children objects contained in this IScene instance

Implementation
public function get children():Vector.<SceneObject>

lightSet

property

lightSet:Vector.<Light> [read-only]

Implementation
public function get lightSet():Vector.<Light>

m_args

property

YOGURT3D_INTERNAL var m_args:Object

m_driver

property

YOGURT3D_INTERNAL var m_driver:String

m_postEffects

property

YOGURT3D_INTERNAL var m_postEffects:Vector.<Effect>

m_rootObject

property

YOGURT3D_INTERNAL var m_rootObject:SceneObject

objectSet

property

objectSet:Vector.<SceneObject> [read-only]

All objects added to this IScene instance (including hierarchical ones, children, grand children) in a one dimensional (flattened) vector.

Implementation
public function get objectSet():Vector.<SceneObject>

postEffects

property

postEffects:Vector.<Effect> [read-only]

Implementation
public function get postEffects():Vector.<Effect>

sceneColor

property

sceneColor:Color

Implementation
public function get sceneColor():Color
public function set sceneColor(value:Color):void

skyBox

property

skyBox:SkyBox

Implementation
public function get skyBox():SkyBox
public function set skyBox(value:SkyBox):void

triangleCount

property

triangleCount:int [read-only]

Implementation
public function get triangleCount():int

Constructor Detail

Scene

()

Constructor

public function Scene(_sceneTreeManagerDriver:String = SimpleSceneTreeManagerDriver, args:Object = null, _initInternals:Boolean = true)

Parameters

	`_sceneTreeManagerDriver:String` (default = `SimpleSceneTreeManagerDriver`)

	`args:Object` (default = `null`)

	`_initInternals:Boolean` (default = `true`)

Method Detail

addChild

()

method

public function addChild(_value:SceneObject):void

Adds given child object into this IScene instance

Parameters

_value:SceneObject

addPostEffect

()

method

public function addPostEffect(_effect:Effect):void

Parameters

_effect:Effect

clearIlluminatorLightIndexes

()

method

public function clearIlluminatorLightIndexes(_scene:IScene, _objectRenderable:SceneObjectRenderable):void

Parameters

	`_scene:IScene`

	`_objectRenderable:SceneObjectRenderable`

containsChild

()

method

public function containsChild(_child:SceneObject, _recursive:Boolean = false):Boolean

Determines whether the specified SceneObject instance is a child of the IScene instance.

Parameters

	`_child:SceneObject` — Child to check.

	`_recursive:Boolean` (default = `false`) — If this argument is false the check only works for the highest hierarchy. If argument is set true the check will work for all children containers.

Returns

Boolean

dispose

()

method

override public function dispose():void

disposeDeep

()

method

override public function disposeDeep():void

disposeGPU

()

method

override public function disposeGPU():void

getChildBySystemID

()

method

public function getChildBySystemID(_value:String):SceneObject

Returns child object that has given systemID.

Parameters

_value:String

Returns

SceneObject

getChildByUserID

()

method

public function getChildByUserID(_value:String):SceneObject

Returns child object that has given userID.

Parameters

_value:String

Returns

SceneObject

getIlluminatorLightIndexes

()

method

public function getIlluminatorLightIndexes(_scene:IScene, _objectRenderable:SceneObjectRenderable):Vector.<int>

Parameters

	`_scene:IScene`

	`_objectRenderable:SceneObjectRenderable`

Returns

Vector.<int>

getIntersectedLightsByCamera

()

method

public function getIntersectedLightsByCamera(_camera:Camera):Vector.<Light>

Parameters

_camera:Camera

Returns

Vector.<Light>

getRenderableSet

()

method

public function getRenderableSet(_camera:Camera):Vector.<SceneObjectRenderable>

SceneObjectRenderable objects added to this IScene instance (including hierarchical ones, children, grand children) in a one dimensional (flattened) vector.

Parameters

_camera:Camera

Returns

Vector.<SceneObjectRenderable>

getRenderableSetLight

()

method

public function getRenderableSetLight(_light:Light, _lightIndex:int):Vector.<SceneObjectRenderable>

Parameters

	`_light:Light`

	`_lightIndex:int`

Returns

Vector.<SceneObjectRenderable>

initInternals

()

method

override protected function initInternals():void

postRender

()

method

public function postRender():void

preRender

()

method

public function preRender(_activeCamera:Camera):void

Parameters

_activeCamera:Camera

removeAllEffects

()

method

public function removeAllEffects():void

removeChild

()

method

public function removeChild(_value:SceneObject):void

Removes given child object from this IScene instance

Parameters

_value:SceneObject

removeChildBySystemID

()

method

public function removeChildBySystemID(_value:String):void

Removes child object that has given systemID from this IScene instance.

Parameters

_value:String

removeChildByUserID

()

method

public function removeChildByUserID(_value:String):void

Removes child object that has given userID from this IScene instance.

Parameters

_value:String

removePostEffect

()

method

public function removePostEffect(_effect:Effect):void

Parameters

_effect:Effect

trackObject

()

method

override protected function trackObject():void

Constant Detail

OCTREE_SCENE

Constant

public static const OCTREE_SCENE:String = OcTreeSceneTreeManagerDriver

QUAD_SCENE

Constant

public static const QUAD_SCENE:String = QuadSceneTreeManagerDriver

SIMPLE_SCENE

Constant

public static const SIMPLE_SCENE:String = SimpleSceneTreeManagerDriver

Mon Jan 23 2012, 09:47 PM +05:00

API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Scene	Properties \| Methods \| Constants

Package	com.yogurt3d.core.sceneobjects
Class	public class Scene
Inheritance	Scene EngineObject Object
Implements	IScene
Subclasses	OctScene, QuadScene