Packageflare.core
Classpublic class Surface3D
InheritanceSurface3D Inheritance flash.events.EventDispatcher

The Surface3D class represents a set of vertices, polygons and surfaces which can be drawn.



Public Properties
 PropertyDefined By
  bounds : Boundings3D
Returns or sets a Boundings3D object with object properties, such as radius, dimensions, etc.
Surface3D
  firstIndex : int = 0
The index of the first vertex index selected to render.
Surface3D
  format : Vector.<String>
The buffer format specified for each input.
Surface3D
  index : int
Surface3D
  indexBuffer : IndexBuffer3D
Buffer of indices that reference to a vertex buffers of the Surface3D.
Surface3D
  indexBytes : ByteArray
Vector of indices that reference to a vertex buffers of the Surface3D.
Surface3D
  indexVector : Vector.<uint>
Vector of indices that reference to a vertex buffers of the Surface3D.
Surface3D
  instanceOf : Surface3D
Gets or sets the instance reference of the surface if there is one.
Surface3D
  material : Material3D
Material instance to render the surface.
Surface3D
  name : String
The name of the surface.
Surface3D
  numTriangles : int = -1
Number of triangles that will be drawn.
Surface3D
  offset : Vector.<int>
The offset of data index in the vertexVector.
Surface3D
  polys : Vector.<Poly3D>
Surface3D
  scene : Scene3D
Gets the scene context of the surface.
Surface3D
  sizePerVertex : int = 0
The number of data values associated with each vertex
Surface3D
  sources : Vector.<Surface3D>
The surface sources of data index from where the input should be read.
Surface3D
  vertexBuffer : VertexBuffer3D
Buffer of vertices that reference to a vertex buffers of the Surface3D.
Surface3D
  vertexBytes : ByteArray
Vector of vertices that reference to a vertex buffers of the Surface3D.
Surface3D
  vertexVector : Vector.<Number>
Vector of vertices that reference to a vertex buffers of the Surface3D.
Surface3D
Public Methods
 MethodDefined By
  
Surface3D(name:String = null)
Creates a new Surface3D object.
Surface3D
  
addVertexData(dataIndex:uint, size:int = -1, vector:Vector.<Number> = null):int
Define a new attribute for each vertex.
Surface3D
  
dispose():void
Surface3D
  
download():void
Surface3D
  
Surface3D
  
upload(scene:Scene3D):void
Surface3D
Public Constants
 ConstantDefined By
  BITANGENT : int = 5
[static] Vertex bi-tangents attribute (float3).
Surface3D
  COLOR0 : int = 9
[static] Vertex color attribute (float3).
Surface3D
  COLOR1 : int = 10
[static] Vertex color attribute (float3).
Surface3D
  COLOR2 : int = 11
[static] Vertex color attribute (float3).
Surface3D
  NORMAL : int = 3
[static] Vertex normals attribute (float3).
Surface3D
  PARTICLE : int = 6
[static] Vertex particles attribute (float4).
Surface3D
  POSITION : int = 0
[static] Vertex position attribute (float3).
Surface3D
  SKIN_INDICES : int = 8
[static] Vertex skin indices attribute (could be float1 to float4 depending of the Device3D.maxBonesPerVertex property).
Surface3D
  SKIN_WEIGHTS : int = 7
[static] Vertex skin weights attribute (could be float1 to float4 depending of the Device3D.maxBonesPerVertex property).
Surface3D
  TANGENT : int = 4
[static] Vertex tangents attribute (float3).
Surface3D
  TARGET_NORMAL : int = 13
[static] Vertex target normal attribute (float3).
Surface3D
  TARGET_POSITION : int = 12
[static] Vertex target position attribute (float3).
Surface3D
  UV0 : int = 1
[static] Vertex primary uv channel attribute (flaot2).
Surface3D
  UV1 : int = 2
[static] Vertex secondary uv channel attribute (float2).
Surface3D
  UV2 : int = 14
[static] Vertex third uv channel attribute (float2).
Surface3D
  UV3 : int = 15
[static] Vertex four uv channel attribute (float2).
Surface3D
Property Detail
boundsproperty
public var bounds:Boundings3D

Returns or sets a Boundings3D object with object properties, such as radius, dimensions, etc.

See also

firstIndexproperty 
public var firstIndex:int = 0

The index of the first vertex index selected to render.

formatproperty 
public var format:Vector.<String>

The buffer format specified for each input.

indexproperty 
public var index:int

indexBufferproperty 
public var indexBuffer:IndexBuffer3D

Buffer of indices that reference to a vertex buffers of the Surface3D.

indexBytesproperty 
public var indexBytes:ByteArray

Vector of indices that reference to a vertex buffers of the Surface3D.

indexVectorproperty 
indexVector:Vector.<uint>

Vector of indices that reference to a vertex buffers of the Surface3D.


Implementation
    public function get indexVector():Vector.<uint>
    public function set indexVector(value:Vector.<uint>):void
instanceOfproperty 
instanceOf:Surface3D

Gets or sets the instance reference of the surface if there is one.


Implementation
    public function get instanceOf():Surface3D
    public function set instanceOf(value:Surface3D):void
materialproperty 
material:Material3D

Material instance to render the surface.


Implementation
    public function get material():Material3D
    public function set material(value:Material3D):void
nameproperty 
public var name:String

The name of the surface.

numTrianglesproperty 
public var numTriangles:int = -1

Number of triangles that will be drawn.

offsetproperty 
public var offset:Vector.<int>

The offset of data index in the vertexVector.

polysproperty 
polys:Vector.<Poly3D>


Implementation
    public function get polys():Vector.<Poly3D>
    public function set polys(value:Vector.<Poly3D>):void
sceneproperty 
public var scene:Scene3D

Gets the scene context of the surface. Do not change this property manually, to change the scene context, call to download() and then to upload() methods.

sizePerVertexproperty 
public var sizePerVertex:int = 0

The number of data values associated with each vertex

sourcesproperty 
public var sources:Vector.<Surface3D>

The surface sources of data index from where the input should be read. A null value means the same surface.

vertexBufferproperty 
public var vertexBuffer:VertexBuffer3D

Buffer of vertices that reference to a vertex buffers of the Surface3D.

vertexBytesproperty 
public var vertexBytes:ByteArray

Vector of vertices that reference to a vertex buffers of the Surface3D.

vertexVectorproperty 
vertexVector:Vector.<Number>

Vector of vertices that reference to a vertex buffers of the Surface3D.


Implementation
    public function get vertexVector():Vector.<Number>
    public function set vertexVector(value:Vector.<Number>):void
Constructor Detail
Surface3D()Constructor
public function Surface3D(name:String = null)

Creates a new Surface3D object.

Parameters
name:String (default = null)
Method Detail
addVertexData()method
public function addVertexData(dataIndex:uint, size:int = -1, vector:Vector.<Number> = null):int

Define a new attribute for each vertex. Each attribute can be a vector of 1-4 values (flotas) associated to each vertex.

The vertexVector can be for example: x,y,z,nx,ny,nz,u,v, x,y,z,nx,ny,nz,u,v, x,y,z,nx,ny,nz,u,v...

Parameters

dataIndex:uint — A value from 0 to 7 that define the type of data to be assocciated. The common values may be one of the POSITION, NORMALS, UV0, UV1, etc. constans of the Surface3D class.
 
size:int (default = -1) — The size of data associated to the attribute for each vertex (1 to 4).
 
vector:Vector.<Number> (default = null)

Returns
int
dispose()method 
public function dispose():void

download()method 
public function download():void

updateBoundings()method 
public function updateBoundings():Boundings3D

Returns
Boundings3D
upload()method 
public function upload(scene:Scene3D):void

Parameters

scene:Scene3D

Constant Detail
BITANGENTConstant
public static const BITANGENT:int = 5

Vertex bi-tangents attribute (float3).

COLOR0Constant 
public static const COLOR0:int = 9

Vertex color attribute (float3).

COLOR1Constant 
public static const COLOR1:int = 10

Vertex color attribute (float3).

COLOR2Constant 
public static const COLOR2:int = 11

Vertex color attribute (float3).

NORMALConstant 
public static const NORMAL:int = 3

Vertex normals attribute (float3).

PARTICLEConstant 
public static const PARTICLE:int = 6

Vertex particles attribute (float4). Life (0-1), rotation in radians and size x and y (-1 to 1).

POSITIONConstant 
public static const POSITION:int = 0

Vertex position attribute (float3).

SKIN_INDICESConstant 
public static const SKIN_INDICES:int = 8

Vertex skin indices attribute (could be float1 to float4 depending of the Device3D.maxBonesPerVertex property).

SKIN_WEIGHTSConstant 
public static const SKIN_WEIGHTS:int = 7

Vertex skin weights attribute (could be float1 to float4 depending of the Device3D.maxBonesPerVertex property).

TANGENTConstant 
public static const TANGENT:int = 4

Vertex tangents attribute (float3).

TARGET_NORMALConstant 
public static const TARGET_NORMAL:int = 13

Vertex target normal attribute (float3).

TARGET_POSITIONConstant 
public static const TARGET_POSITION:int = 12

Vertex target position attribute (float3).

UV0Constant 
public static const UV0:int = 1

Vertex primary uv channel attribute (flaot2).

UV1Constant 
public static const UV1:int = 2

Vertex secondary uv channel attribute (float2).

UV2Constant 
public static const UV2:int = 14

Vertex third uv channel attribute (float2).

UV3Constant 
public static const UV3:int = 15

Vertex four uv channel attribute (float2).