Packagecom.yogurt3d.core.sceneobjects
Classpublic class SceneObjectContainer
InheritanceSceneObjectContainer Inheritance SceneObject Inheritance EngineObject Inheritance Object
Implements ISceneObjectContainer
Subclasses Camera, RenderableLight

ISceneObjectContainer interface abstract type.



Public Properties
 PropertyDefined By
  children : Vector.<ISceneObject>
[read-only] Children objects this ISceneObjectContainer instance have.
SceneObjectContainer
 Inheritedparent : ISceneObject
[read-only] Indicates the container that contains this object.
SceneObject
 Inheritedroot : ISceneObject
[read-only] Indicates the top-most relative container that contains this object.
SceneObject
 Inheritedscene : IScene
[read-only] Indicates the scene that contains this object.
SceneObject
 InheritedsystemID : String
[read-only] Automatically assigned id.
EngineObject
 Inheritedtransformation : Transformation
[read-only] Transformation of this object
SceneObject
 InheriteduserID : String
Identification string can be assigned by developer to identify objects.
EngineObject
  visible : Boolean
SceneObjectContainer
Public Methods
 MethodDefined By
  
SceneObjectContainer(_initInternals:Boolean = true)
SceneObjectContainer
  
addChild(_value:ISceneObject):void
Adds specified child object into this ISceneObjectContainer instance.
SceneObjectContainer
  
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
[override]
SceneObjectContainer
  
[override]
SceneObjectContainer
  
containsChild(_child:ISceneObject, _recursive:Boolean = false):Boolean
Determines whether the specified ISceneObject instance is a child of the ISceneObjectContainer instance.
SceneObjectContainer
 Inherited
dispatchEvent(event:Event):Boolean
SceneObject
 Inherited
dispose():void
[override]
SceneObject
  
Returns child object that has the given systemID.
SceneObjectContainer
  
Returns child object that has the given userID.
SceneObjectContainer
 Inherited
hasEventListener(type:String):Boolean
SceneObject
 Inherited
Removes all external referances and clears internals.
EngineObject
  
Removes specified child object from this ISceneObjectContainer instance.
SceneObjectContainer
  
removeChildBySystemID(_value:String):void
Removes child object that has the given systemID from this ISceneObjectContainer instance.
SceneObjectContainer
  
removeChildByUserID(_value:String):void
Removes child object that has the given userID from this ISceneObjectContainer instance.
SceneObjectContainer
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
[override]
SceneObjectContainer
 Inherited
renew():void
Renews object internals and resets properties of object.
EngineObject
 Inherited
toString():String
Returns a string identifier on this object
EngineObject
 Inherited
willTrigger(type:String):Boolean
SceneObject
Protected Methods
 MethodDefined By
 Inherited
[override]
SceneObject
  
[override]
SceneObjectContainer
Property Detail
childrenproperty
children:Vector.<ISceneObject>  [read-only]

Children objects this ISceneObjectContainer instance have.


Implementation
    public function get children():Vector.<ISceneObject>
m_visibleproperty 
YOGURT3D_INTERNAL var m_visible:Boolean = true

visibleproperty 
visible:Boolean


Implementation
    public function get visible():Boolean
    public function set visible(value:Boolean):void
Constructor Detail
SceneObjectContainer()Constructor
public function SceneObjectContainer(_initInternals:Boolean = true)



Parameters
_initInternals:Boolean (default = true)
Method Detail
addChild()method
public function addChild(_value:ISceneObject):void

Adds specified child object into this ISceneObjectContainer instance.

Parameters

_value:ISceneObject

addEventListener()method 
override public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void

Parameters

type:String
 
listener:Function
 
useCapture:Boolean (default = false)
 
priority:int (default = 0)
 
useWeakReference:Boolean (default = false)

clone()method 
override public function clone():IEngineObject

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

Determines whether the specified ISceneObject instance is a child of the ISceneObjectContainer 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 works for all children containers recursively.

Returns
Boolean
getChildBySystemID()method 
public function getChildBySystemID(_value:String):ISceneObject

Returns child object that has the given systemID.

Parameters

_value:String

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

Returns child object that has the given userID.

Parameters

_value:String

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

Removes specified child object from this ISceneObjectContainer instance.

Parameters

_value:ISceneObject

removeChildBySystemID()method 
public function removeChildBySystemID(_value:String):void

Removes child object that has the given systemID from this ISceneObjectContainer instance.

Parameters

_value:String

removeChildByUserID()method 
public function removeChildByUserID(_value:String):void

Removes child object that has the given userID from this ISceneObjectContainer instance.

Parameters

_value:String

removeEventListener()method 
override public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

Parameters

type:String
 
listener:Function
 
useCapture:Boolean (default = false)

trackObject()method 
override protected function trackObject():void