Packageaway3d.core.managers
Classpublic class Stage3DManager
InheritanceStage3DManager Inheritance Object

The Stage3DManager class provides a multiton object that handles management for Stage3D objects. Stage3D objects should not be requested directly, but are exposed by a Stage3DProxy.

See also

away3d.core.managers.Stage3DProxy

Public Properties
 PropertyDefined By
  hasFreeStage3DProxy : Boolean
[read-only] Checks if a new stage3DProxy can be created and managed by the class.
Stage3DManager
  numProxySlotsFree : uint
[read-only] Returns the amount of stage3DProxy objects that can be created and managed by the class
Stage3DManager
  numProxySlotsTotal : uint
[read-only] Returns the maximum amount of Stage3DProxy objects that can be managed by the class
Stage3DManager
  numProxySlotsUsed : uint
[read-only] Returns the amount of Stage3DProxy objects currently managed by the class.
Stage3DManager
Public Methods
 MethodDefined By
  
getFreeStage3DProxy(forceSoftware:Boolean = false, profile:String = baseline):Stage3DProxy
Get the next available stage3DProxy.
Stage3DManager
  
getInstance(stage:Stage):Stage3DManager
[static] Gets a Stage3DManager instance for the given Stage object.
Stage3DManager
  
getStage3DProxy(index:uint, forceSoftware:Boolean = false, profile:String = baseline):Stage3DProxy
Requests the Stage3DProxy for the given index.
Stage3DManager
Property Detail
hasFreeStage3DProxyproperty
hasFreeStage3DProxy:Boolean  [read-only]

Checks if a new stage3DProxy can be created and managed by the class.


Implementation
    public function get hasFreeStage3DProxy():Boolean
numProxySlotsFreeproperty 
numProxySlotsFree:uint  [read-only]

Returns the amount of stage3DProxy objects that can be created and managed by the class


Implementation
    public function get numProxySlotsFree():uint
numProxySlotsTotalproperty 
numProxySlotsTotal:uint  [read-only]

Returns the maximum amount of Stage3DProxy objects that can be managed by the class


Implementation
    public function get numProxySlotsTotal():uint
numProxySlotsUsedproperty 
numProxySlotsUsed:uint  [read-only]

Returns the amount of Stage3DProxy objects currently managed by the class.


Implementation
    public function get numProxySlotsUsed():uint
Method Detail
getFreeStage3DProxy()method
public function getFreeStage3DProxy(forceSoftware:Boolean = false, profile:String = baseline):Stage3DProxy

Get the next available stage3DProxy. An error is thrown if there are no Stage3DProxies available

Parameters

forceSoftware:Boolean (default = false) — Whether to force software mode even if hardware acceleration is available.
 
profile:String (default = baseline) — The compatibility profile, an enumeration of Context3DProfile

Returns
Stage3DProxy — The allocated stage3DProxy
getInstance()method 
public static function getInstance(stage:Stage):Stage3DManager

Gets a Stage3DManager instance for the given Stage object.

Parameters

stage:Stage — The Stage object that contains the Stage3D objects to be managed.

Returns
Stage3DManager — The Stage3DManager instance for the given Stage object.
getStage3DProxy()method 
public function getStage3DProxy(index:uint, forceSoftware:Boolean = false, profile:String = baseline):Stage3DProxy

Requests the Stage3DProxy for the given index.

Parameters

index:uint — The index of the requested Stage3D.
 
forceSoftware:Boolean (default = false) — Whether to force software mode even if hardware acceleration is available.
 
profile:String (default = baseline) — The compatibility profile, an enumeration of Context3DProfile

Returns
Stage3DProxy — The Stage3DProxy for the given index.




Tue May 7 2013, 10:42 PM +01:00