Packageaway3d.core.base
Interfacepublic interface IRenderable extends IMaterialOwner
ImplementorsSegmentsBase, SkyBox, Sprite3D, SubMesh

IRenderable provides an interface for objects that can be rendered in the rendering pipeline.

Public Properties
 PropertyDefined by
 Inheritedanimation : AnimationBase
The animation used by the material to assemble the vertex code.
IMaterialOwner
 InheritedanimationState : AnimationStateBase
IMaterialOwner
  castsShadows : Boolean
[read-only] Indicates whether the renderable can cast shadows
IRenderable
  inverseSceneTransform : Matrix3D
[read-only] The inverse scene transform object that transforms from world to model space.
IRenderable
 Inheritedmaterial : MaterialBase
The material with which to render the object.
IMaterialOwner
  modelViewProjection : Matrix3D
[read-only] The model-view-projection (MVP) matrix used to transform from model to homogeneous projection space.
IRenderable
  mouseDetails : Boolean
[read-only] Indicates whether the IRenderable needs to provide mouse event details, such as position and uv coordinates.
IRenderable
  mouseEnabled : Boolean
[read-only] Indicates whether the IRenderable should trigger mouse events, and hence should be rendered for hit testing.
IRenderable
  numTriangles : uint
[read-only] The amount of triangles that comprise the IRenderable geometry.
IRenderable
  sceneTransform : Matrix3D
[read-only] The transformation matrix that transforms from model to world space.
IRenderable
  sourceEntity : Entity
[read-only] The entity that that initially provided the IRenderable to the render pipeline.
IRenderable
  zIndex : Number
[read-only] The distance of the IRenderable object to the view, used to sort per object.
IRenderable
Public Methods
 MethodDefined by
  
getIndexBuffer(context:Context3D, contextIndex:uint):IndexBuffer3D
Retrieves the VertexBuffer3D object that contains triangle indices.
IRenderable
  
getUVBuffer(context:Context3D, contextIndex:uint):VertexBuffer3D
Retrieves the VertexBuffer3D object that contains texture coordinates.
IRenderable
  
getVertexBuffer(context:Context3D, contextIndex:uint):VertexBuffer3D
Retrieves the VertexBuffer3D object that contains vertex positions.
IRenderable
  
getVertexNormalBuffer(context:Context3D, contextIndex:uint):VertexBuffer3D
Retrieves the VertexBuffer3D object that contains vertex normals.
IRenderable
  
getVertexTangentBuffer(context:Context3D, contextIndex:uint):VertexBuffer3D
Retrieves the VertexBuffer3D object that contains vertex tangents.
IRenderable
Property detail
castsShadowsproperty
castsShadows:Boolean  [read-only]

Indicates whether the renderable can cast shadows

Implementation
    public function get castsShadows():Boolean
inverseSceneTransformproperty 
inverseSceneTransform:Matrix3D  [read-only]

The inverse scene transform object that transforms from world to model space.

Implementation
    public function get inverseSceneTransform():Matrix3D
modelViewProjectionproperty 
modelViewProjection:Matrix3D  [read-only]

The model-view-projection (MVP) matrix used to transform from model to homogeneous projection space.

Implementation
    public function get modelViewProjection():Matrix3D
mouseDetailsproperty 
mouseDetails:Boolean  [read-only]

Indicates whether the IRenderable needs to provide mouse event details, such as position and uv coordinates.

Implementation
    public function get mouseDetails():Boolean
mouseEnabledproperty 
mouseEnabled:Boolean  [read-only]

Indicates whether the IRenderable should trigger mouse events, and hence should be rendered for hit testing.

Implementation
    public function get mouseEnabled():Boolean
numTrianglesproperty 
numTriangles:uint  [read-only]

The amount of triangles that comprise the IRenderable geometry.

Implementation
    public function get numTriangles():uint
sceneTransformproperty 
sceneTransform:Matrix3D  [read-only]

The transformation matrix that transforms from model to world space.

Implementation
    public function get sceneTransform():Matrix3D
sourceEntityproperty 
sourceEntity:Entity  [read-only]

The entity that that initially provided the IRenderable to the render pipeline.

Implementation
    public function get sourceEntity():Entity
zIndexproperty 
zIndex:Number  [read-only]

The distance of the IRenderable object to the view, used to sort per object.

Implementation
    public function get zIndex():Number
Method detail
getIndexBuffer()method
public function getIndexBuffer(context:Context3D, contextIndex:uint):IndexBuffer3D

Retrieves the VertexBuffer3D object that contains triangle indices.

Parameters
context:Context3D — The Context3D for which we request the buffer
 
contextIndex:uint

Returns
IndexBuffer3D — The VertexBuffer3D object that contains triangle indices.
getUVBuffer()method 
public function getUVBuffer(context:Context3D, contextIndex:uint):VertexBuffer3D

Retrieves the VertexBuffer3D object that contains texture coordinates.

Parameters
context:Context3D — The Context3D for which we request the buffer
 
contextIndex:uint

Returns
VertexBuffer3D — The VertexBuffer3D object that contains texture coordinates.
getVertexBuffer()method 
public function getVertexBuffer(context:Context3D, contextIndex:uint):VertexBuffer3D

Retrieves the VertexBuffer3D object that contains vertex positions.

Parameters
context:Context3D — The Context3D for which we request the buffer
 
contextIndex:uint

Returns
VertexBuffer3D — The VertexBuffer3D object that contains vertex positions.
getVertexNormalBuffer()method 
public function getVertexNormalBuffer(context:Context3D, contextIndex:uint):VertexBuffer3D

Retrieves the VertexBuffer3D object that contains vertex normals.

Parameters
context:Context3D — The Context3D for which we request the buffer
 
contextIndex:uint

Returns
VertexBuffer3D — The VertexBuffer3D object that contains vertex normals.
getVertexTangentBuffer()method 
public function getVertexTangentBuffer(context:Context3D, contextIndex:uint):VertexBuffer3D

Retrieves the VertexBuffer3D object that contains vertex tangents.

Parameters
context:Context3D — The Context3D for which we request the buffer
 
contextIndex:uint

Returns
VertexBuffer3D — The VertexBuffer3D object that contains vertex tangents.
Wiki link
Click to go to the wiki page for ####WIKI####

Code examples

Comments