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

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



Public Properties
 PropertyDefined By
 Inheritedanimator : IAnimator
[read-only] The animation used by the material to assemble the vertex code.
IMaterialOwner
  castsShadows : Boolean
[read-only] Indicates whether the renderable can cast shadows
IRenderable
  indexData : Vector.<uint>
[read-only] Retrieves the object's indices as a uint array.
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
  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
  numVertices : uint
[read-only] The total amount of vertices in the SubGeometry.
IRenderable
  sceneTransform : Matrix3D
[read-only] The transformation matrix that transforms from model to world space.
IRenderable
  shaderPickingDetails : Boolean
[read-only]
IRenderable
  sourceEntity : Entity
[read-only] The entity that that initially provided the IRenderable to the render pipeline.
IRenderable
  UVData : Vector.<Number>
[read-only] Retrieves the object's uvs as a Number array.
IRenderable
  uvTransform : Matrix
[read-only] Provides a Matrix object to transform the uv coordinates, if the material supports it.
IRenderable
  vertexData : Vector.<Number>
[read-only] Retrieves the object's vertices as a Number array.
IRenderable
  vertexNormalData : Vector.<Number>
[read-only] Retrieves the object's normals as a Number array.
IRenderable
  vertexStride : uint
[read-only] The number of data elements in the buffers per vertex.
IRenderable
  vertexTangentData : Vector.<Number>
[read-only] Retrieves the object's tangents as a Number array.
IRenderable
Public Methods
 MethodDefined By
  
activateSecondaryUVBuffer(index:int, stage3DProxy:Stage3DProxy):void
Assigns the attribute stream for a secondary set of UV coordinates
IRenderable
  
activateUVBuffer(index:int, stage3DProxy:Stage3DProxy):void
Assigns the attribute stream for UV coordinates
IRenderable
  
activateVertexBuffer(index:int, stage3DProxy:Stage3DProxy):void
Assigns the attribute stream for vertex positions.
IRenderable
  
activateVertexNormalBuffer(index:int, stage3DProxy:Stage3DProxy):void
Assigns the attribute stream for vertex normals
IRenderable
  
activateVertexTangentBuffer(index:int, stage3DProxy:Stage3DProxy):void
Assigns the attribute stream for vertex tangents
IRenderable
  
getIndexBuffer(stage3DProxy:Stage3DProxy):IndexBuffer3D
Retrieves the IndexBuffer3D object that contains triangle indices.
IRenderable
  
The transformation matrix that transforms from model to world space, adapted with any special operations needed to render.
IRenderable
Property Detail
castsShadowsproperty
castsShadows:Boolean  [read-only]

Indicates whether the renderable can cast shadows


Implementation
    public function get castsShadows():Boolean
indexDataproperty 
indexData:Vector.<uint>  [read-only]

Retrieves the object's indices as a uint array.


Implementation
    public function get indexData():Vector.<uint>
inverseSceneTransformproperty 
inverseSceneTransform:Matrix3D  [read-only]

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


Implementation
    public function get inverseSceneTransform():Matrix3D
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
numVerticesproperty 
numVertices:uint  [read-only]

The total amount of vertices in the SubGeometry.


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

The transformation matrix that transforms from model to world space.


Implementation
    public function get sceneTransform():Matrix3D
shaderPickingDetailsproperty 
shaderPickingDetails:Boolean  [read-only]


Implementation
    public function get shaderPickingDetails():Boolean
sourceEntityproperty 
sourceEntity:Entity  [read-only]

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


Implementation
    public function get sourceEntity():Entity
UVDataproperty 
UVData:Vector.<Number>  [read-only]

Retrieves the object's uvs as a Number array.


Implementation
    public function get UVData():Vector.<Number>
uvTransformproperty 
uvTransform:Matrix  [read-only]

Provides a Matrix object to transform the uv coordinates, if the material supports it. For TextureMaterial and TextureMultiPassMaterial, the animateUVs property should be set to true.


Implementation
    public function get uvTransform():Matrix
vertexDataproperty 
vertexData:Vector.<Number>  [read-only]

Retrieves the object's vertices as a Number array.


Implementation
    public function get vertexData():Vector.<Number>
vertexNormalDataproperty 
vertexNormalData:Vector.<Number>  [read-only]

Retrieves the object's normals as a Number array.


Implementation
    public function get vertexNormalData():Vector.<Number>
vertexStrideproperty 
vertexStride:uint  [read-only]

The number of data elements in the buffers per vertex. This always applies to vertices, normals and tangents.


Implementation
    public function get vertexStride():uint
vertexTangentDataproperty 
vertexTangentData:Vector.<Number>  [read-only]

Retrieves the object's tangents as a Number array.


Implementation
    public function get vertexTangentData():Vector.<Number>
Method Detail
activateSecondaryUVBuffer()method
public function activateSecondaryUVBuffer(index:int, stage3DProxy:Stage3DProxy):void

Assigns the attribute stream for a secondary set of UV coordinates

Parameters

index:int — The attribute stream index for the vertex shader
 
stage3DProxy:Stage3DProxy — The Stage3DProxy to assign the stream to

activateUVBuffer()method 
public function activateUVBuffer(index:int, stage3DProxy:Stage3DProxy):void

Assigns the attribute stream for UV coordinates

Parameters

index:int — The attribute stream index for the vertex shader
 
stage3DProxy:Stage3DProxy — The Stage3DProxy to assign the stream to

activateVertexBuffer()method 
public function activateVertexBuffer(index:int, stage3DProxy:Stage3DProxy):void

Assigns the attribute stream for vertex positions.

Parameters

index:int — The attribute stream index for the vertex shader
 
stage3DProxy:Stage3DProxy — The Stage3DProxy to assign the stream to

activateVertexNormalBuffer()method 
public function activateVertexNormalBuffer(index:int, stage3DProxy:Stage3DProxy):void

Assigns the attribute stream for vertex normals

Parameters

index:int — The attribute stream index for the vertex shader
 
stage3DProxy:Stage3DProxy — The Stage3DProxy to assign the stream to

activateVertexTangentBuffer()method 
public function activateVertexTangentBuffer(index:int, stage3DProxy:Stage3DProxy):void

Assigns the attribute stream for vertex tangents

Parameters

index:int — The attribute stream index for the vertex shader
 
stage3DProxy:Stage3DProxy — The Stage3DProxy to assign the stream to

getIndexBuffer()method 
public function getIndexBuffer(stage3DProxy:Stage3DProxy):IndexBuffer3D

Retrieves the IndexBuffer3D object that contains triangle indices.

Parameters

stage3DProxy:Stage3DProxy — The Context3D for which we request the buffer

Returns
IndexBuffer3D — The VertexBuffer3D object that contains triangle indices.
getRenderSceneTransform()method 
public function getRenderSceneTransform(camera:Camera3D):Matrix3D

The transformation matrix that transforms from model to world space, adapted with any special operations needed to render. For example, assuring certain alignedness which is not inherent in the scene transform. By default, this would return the scene transform.

Parameters

camera:Camera3D

Returns
Matrix3D