Packagecom.yogurt3d.core.sceneobjects.interfaces
Interfacepublic interface ISceneObjectContainer extends ISceneObject, IEngineObject, flash.events.IEventDispatcher, IIdentifiableObject, IReconstructibleObject
Implementors SceneObjectContainer

Container object can contain children. Makes it easy to create hierarchies between objects.


Public Properties
 PropertyDefined By
  children : Vector.<ISceneObject>
[read-only] Children objects this ISceneObjectContainer instance have.
ISceneObjectContainer
 Inheritedparent : ISceneObject
[read-only] Indicates the container that contains this object.
ISceneObject
 Inheritedroot : ISceneObject
[read-only] Indicates the top-most relative container that contains this object.
ISceneObject
 Inheritedscene : IScene
[read-only] Indicates the scene that contains this object.
ISceneObject
 InheritedsystemID : String
[read-only] Automatically assigned id.
IIdentifiableObject
 Inheritedtransformation : Transformation
[read-only] Transformation of this object
ISceneObject
 InheriteduserID : String
Identification string can be assigned by developer to identify objects.
IIdentifiableObject
  visible : Boolean
Sets the visiblity of children
ISceneObjectContainer
Public Methods
 MethodDefined By
  
addChild(_value:ISceneObject):void
Adds specified child object into this ISceneObjectContainer instance.
ISceneObjectContainer
 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 ISceneObjectContainer instance.
ISceneObjectContainer
 Inherited
dispose():void
Removes all external referances and clears internals.
IReconstructibleObject
  
getChildBySystemID(_value:String):ISceneObject
Returns child object that has the given systemID.
ISceneObjectContainer
  
getChildByUserID(_value:String):ISceneObject
Returns child object that has the given userID.
ISceneObjectContainer
 Inherited
instance():*
Removes all external referances and clears internals.
IReconstructibleObject
  
removeChild(_value:ISceneObject):void
Removes specified child object from this ISceneObjectContainer instance.
ISceneObjectContainer
  
removeChildBySystemID(_value:String):void
Removes child object that has the given systemID from this ISceneObjectContainer instance.
ISceneObjectContainer
  
removeChildByUserID(_value:String):void
Removes child object that has the given userID from this ISceneObjectContainer instance.
ISceneObjectContainer
 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
childrenproperty
children:Vector.<ISceneObject>  [read-only]

Children objects this ISceneObjectContainer instance have.


Implementation
    public function get children():Vector.<ISceneObject>
visibleproperty 
visible:Boolean

Sets the visiblity of children


Implementation
    public function get visible():Boolean
    public function set visible(value:Boolean):void
Method Detail
addChild()method
public function addChild(_value:ISceneObject):void

Adds specified child object into this ISceneObjectContainer 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 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





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