Packagecom.yogurt3d.core.sceneobjects.interfaces
Interfacepublic interface IScene extends IEngineObject, IIdentifiableObject, IReconstructibleObject
Implementors Scene

IScene interface defines methods and properties of scene objects.


Public Properties
 PropertyDefined By
  cameraSet : Vector.<ICamera>
[read-only] ICamera objects added to this IScene instance (including hierarchical ones, children, grand children) in a one dimensional (flattened) vector.
IScene
  children : Vector.<ISceneObject>
[read-only] Top level children objects contained in this IScene instance
IScene
  lightSet : Vector.<ILight>
[read-only]
IScene
  objectSet : Vector.<ISceneObject>
[read-only] All objects added to this IScene instance (including hierarchical ones, children, grand children) in a one dimensional (flattened) vector.
IScene
  renderableSet : Vector.<ISceneObjectRenderable>
[read-only] ISceneObjectRenderable objects added to this IScene instance (including hierarchical ones, children, grand children) in a one dimensional (flattened) vector.
IScene
  sceneColor : uint
IScene
  sceneColorSplit : Vector.<Number>
[read-only]
IScene
  skyBox : SkyBox
IScene
 InheritedsystemID : String
[read-only] Automatically assigned id.
IIdentifiableObject
  triangleCount : int
[read-only]
IScene
 InheriteduserID : String
Identification string can be assigned by developer to identify objects.
IIdentifiableObject
Public Methods
 MethodDefined By
  
addChild(_value:ISceneObject):void
Adds given child object into this IScene instance
IScene
 Inherited
clone():IEngineObject
Creates new clone object.
IReconstructibleObject
  
containsChild(_child:ISceneObject, _recursive:Boolean = false):Boolean
Determines whether the specified ISceneObject instance is a child of the IScene instance.
IScene
 Inherited
dispose():void
Removes all external referances and clears internals.
IReconstructibleObject
  
getChildBySystemID(_value:String):ISceneObject
Returns child object that has given systemID.
IScene
  
getChildByUserID(_value:String):ISceneObject
Returns child object that has given userID.
IScene
 Inherited
instance():*
Removes all external referances and clears internals.
IReconstructibleObject
  
removeChild(_value:ISceneObject):void
Removes given child object from this IScene instance
IScene
  
removeChildBySystemID(_value:String):void
Removes child object that has given systemID from this IScene instance.
IScene
  
removeChildByUserID(_value:String):void
Removes child object that has given userID from this IScene instance.
IScene
 Inherited
renew():void
Renews object internals and resets properties of object.
IReconstructibleObject
 Inherited
toString():String
Returns a string identifier on this object
IEngineObject
Property Detail
cameraSetproperty
cameraSet:Vector.<ICamera>  [read-only]

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


Implementation
    public function get cameraSet():Vector.<ICamera>
childrenproperty 
children:Vector.<ISceneObject>  [read-only]

Top level children objects contained in this IScene instance


Implementation
    public function get children():Vector.<ISceneObject>
lightSetproperty 
lightSet:Vector.<ILight>  [read-only]


Implementation
    public function get lightSet():Vector.<ILight>
objectSetproperty 
objectSet:Vector.<ISceneObject>  [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.<ISceneObject>
renderableSetproperty 
renderableSet:Vector.<ISceneObjectRenderable>  [read-only]

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


Implementation
    public function get renderableSet():Vector.<ISceneObjectRenderable>
sceneColorproperty 
sceneColor:uint


Implementation
    public function get sceneColor():uint
    public function set sceneColor(value:uint):void
sceneColorSplitproperty 
sceneColorSplit:Vector.<Number>  [read-only]


Implementation
    public function get sceneColorSplit():Vector.<Number>
skyBoxproperty 
skyBox:SkyBox


Implementation
    public function get skyBox():SkyBox
    public function set skyBox(value:SkyBox):void
triangleCountproperty 
triangleCount:int  [read-only]


Implementation
    public function get triangleCount():int
Method Detail
addChild()method
public function addChild(_value:ISceneObject):void

Adds given child object into this IScene instance

Parameters

_value:ISceneObject

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

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

Parameters

_child:ISceneObject — 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
getChildBySystemID()method 
public function getChildBySystemID(_value:String):ISceneObject

Returns child object that has given systemID.

Parameters

_value:String

Returns
ISceneObject
getChildByUserID()method 
public function getChildByUserID(_value:String):ISceneObject

Returns child object that has given userID.

Parameters

_value:String

Returns
ISceneObject
removeChild()method 
public function removeChild(_value:ISceneObject):void

Removes given child object from this IScene instance

Parameters

_value:ISceneObject

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





Tue Jul 19 2011, 08:18 PM +03:00