Package | away3d.entities |
Class | public class SegmentSet |
Inheritance | SegmentSet Entity ObjectContainer3D Object3D NamedAssetBase flash.events.EventDispatcher |
Implements | IRenderable |
Subclasses | MeshDebug, TridentLines, WireframeAxesGrid, WireframePrimitiveBase |
Property | Defined By | ||
---|---|---|---|
animator : IAnimator [read-only] | SegmentSet | ||
assetFullPath : Array [read-only] | NamedAssetBase | ||
assetNamespace : String [read-only] | NamedAssetBase | ||
assetType : String [override] [read-only] | SegmentSet | ||
backVector : Vector3D [read-only]
| Object3D | ||
bounds : BoundingVolumeBase
The bounding volume approximating the volume occupied by the Entity. | Entity | ||
castsShadows : Boolean [read-only] | SegmentSet | ||
downVector : Vector3D [read-only]
| Object3D | ||
eulers : Vector3D
Defines the rotation of the 3d object as a Vector3D object containing euler angles for rotation around x, y and z axis. | Object3D | ||
extra : Object
An object that can contain any extra data. | Object3D | ||
forwardVector : Vector3D [read-only]
| Object3D | ||
id : String | NamedAssetBase | ||
ignoreTransform : Boolean [override] | Entity | ||
indexData : Vector.<uint> [read-only] | SegmentSet | ||
inverseSceneTransform : Matrix3D [read-only]
The inverse scene transform object that transforms from world to model space. | ObjectContainer3D | ||
leftVector : Vector3D [read-only]
| Object3D | ||
material : MaterialBase | SegmentSet | ||
maxX : Number [override] [read-only]
The maximum extremum of the object along the X-axis. | Entity | ||
maxY : Number [override] [read-only]
The maximum extremum of the object along the Y-axis. | Entity | ||
maxZ : Number [override] [read-only]
The maximum extremum of the object along the Z-axis. | Entity | ||
minX : Number [override] [read-only]
The minimum extremum of the object along the X-axis. | Entity | ||
minY : Number [override] [read-only]
The minimum extremum of the object along the Y-axis. | Entity | ||
minZ : Number [override] [read-only]
The minimum extremum of the object along the Z-axis. | Entity | ||
mouseChildren : Boolean | ObjectContainer3D | ||
mouseEnabled : Boolean [override]
Indicates whether the IRenderable should trigger mouse events, and hence should be rendered for hit testing. | SegmentSet | ||
name : String | NamedAssetBase | ||
numChildren : uint [read-only]
The amount of child objects of the ObjectContainer3D. | ObjectContainer3D | ||
numTriangles : uint [read-only] | SegmentSet | ||
numVertices : uint [read-only] | SegmentSet | ||
originalName : String [read-only]
The original name used for this asset in the resource (e.g. | NamedAssetBase | ||
parent : ObjectContainer3D [read-only]
The parent ObjectContainer3D to which this object's transformation is relative. | ObjectContainer3D | ||
partition : Partition3D
The space partition to be used by the object container and all its recursive children, unless it has its own
space partition assigned. | ObjectContainer3D | ||
pickingCollider : IPickingCollider
Used by the raycast-based picking system to determine how the geometric contents of an entity are processed
in order to offer more details for the picking collision object, including local position, normal vector and uv value. | Entity | ||
pickingCollisionVO : PickingCollisionVO [read-only]
Returns a unique picking collision value object for the entity. | Entity | ||
pivotPoint : Vector3D
Defines the local point around which the object rotates. | Object3D | ||
position : Vector3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D. | Object3D | ||
rightVector : Vector3D [read-only]
| Object3D | ||
rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D. | Object3D | ||
rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D. | Object3D | ||
rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D. | Object3D | ||
scaleX : Number
Defines the scale of the 3d object along the x-axis, relative to local coordinates. | Object3D | ||
scaleY : Number
Defines the scale of the 3d object along the y-axis, relative to local coordinates. | Object3D | ||
scaleZ : Number
Defines the scale of the 3d object along the z-axis, relative to local coordinates. | Object3D | ||
scene : Scene3D [override]
A reference to the Scene3D object to which this object belongs. | Entity | ||
scenePosition : Vector3D [read-only]
The global position of the ObjectContainer3D in the scene. | ObjectContainer3D | ||
sceneTransform : Matrix3D [read-only]
The transformation matrix that transforms from model to world space. | ObjectContainer3D | ||
segmentCount : uint [read-only]
| SegmentSet | ||
shaderPickingDetails : Boolean
Used by the shader-based picking system to determine whether a separate render pass is made in order
to offer more details for the picking collision object, including local position, normal vector and uv value. | Entity | ||
showBounds : Boolean | Entity | ||
sourceEntity : Entity [read-only] | SegmentSet | ||
staticNode : Boolean
Defines whether or not the object will be moved or animated at runtime. | Entity | ||
transform : Matrix3D
The transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D. | Object3D | ||
upVector : Vector3D [read-only]
| Object3D | ||
UVData : Vector.<Number> [read-only] | SegmentSet | ||
uvTransform : Matrix [read-only] | SegmentSet | ||
vertexData : Vector.<Number> [read-only] | SegmentSet | ||
vertexNormalData : Vector.<Number> [read-only] | SegmentSet | ||
vertexNormalOffset : int [read-only] | SegmentSet | ||
vertexOffset : int [read-only] | SegmentSet | ||
vertexStride : uint [read-only] | SegmentSet | ||
vertexTangentData : Vector.<Number> [read-only] | SegmentSet | ||
vertexTangentOffset : int [read-only] | SegmentSet | ||
visible : Boolean | ObjectContainer3D | ||
worldBounds : BoundingVolumeBase [read-only] | Entity | ||
x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D. | Object3D | ||
y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D. | Object3D | ||
z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D. | Object3D | ||
zOffset : int | Object3D |
Property | Defined By | ||
---|---|---|---|
_bounds : BoundingVolumeBase | Entity | ||
_boundsInvalid : Boolean = true | Entity | ||
_explicitPartition : Partition3D | ObjectContainer3D | ||
_ignoreTransform : Boolean = false | ObjectContainer3D | ||
_implicitPartition : Partition3D | ObjectContainer3D | ||
_mouseEnabled : Boolean | ObjectContainer3D | ||
_parent : ObjectContainer3D | ObjectContainer3D | ||
_pivotPoint : Vector3D | Object3D | ||
_pivotZero : Boolean = true | Object3D | ||
_pos : Vector3D | Object3D | ||
_rot : Vector3D | Object3D | ||
_sca : Vector3D | Object3D | ||
_scaleX : Number = 1 | Object3D | ||
_scaleY : Number = 1 | Object3D | ||
_scaleZ : Number = 1 | Object3D | ||
_scene : Scene3D | ObjectContainer3D | ||
_sceneTransform : Matrix3D | ObjectContainer3D | ||
_sceneTransformDirty : Boolean = true | ObjectContainer3D | ||
_segments : Dictionary | SegmentSet | ||
_transform : Matrix3D | Object3D | ||
_transformComponents : Vector.<Vector3D> | Object3D | ||
_x : Number = 0 | Object3D | ||
_y : Number = 0 | Object3D | ||
_z : Number = 0 | Object3D | ||
_zOffset : int = 0 | Object3D |
Method | Defined By | ||
---|---|---|---|
Creates a new SegmentSet object. | SegmentSet | ||
activateSecondaryUVBuffer(index:int, stage3DProxy:Stage3DProxy):void | SegmentSet | ||
activateUVBuffer(index:int, stage3DProxy:Stage3DProxy):void | SegmentSet | ||
activateVertexBuffer(index:int, stage3DProxy:Stage3DProxy):void | SegmentSet | ||
activateVertexNormalBuffer(index:int, stage3DProxy:Stage3DProxy):void | SegmentSet | ||
activateVertexTangentBuffer(index:int, stage3DProxy:Stage3DProxy):void | SegmentSet | ||
Adds a child ObjectContainer3D to the current object. | ObjectContainer3D | ||
addChildren(... childarray):void
Adds an array of 3d objects to the scene as children of the container
| ObjectContainer3D | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void [override] | ObjectContainer3D | ||
addSegment(segment:Segment):void
Adds a new segment to the SegmentSet. | SegmentSet | ||
assetPathEquals(name:String, ns:String):Boolean | NamedAssetBase | ||
[override]
Clones this ObjectContainer3D instance along with all it's children, and
returns the result (which will be a copy of this container, containing copies
of all it's children.)
| ObjectContainer3D | ||
contains(child:ObjectContainer3D):Boolean | ObjectContainer3D | ||
dispatchEvent(event:Event):Boolean [override]
| ObjectContainer3D | ||
dispose():void [override]
Cleans up resources used by this asset. | SegmentSet | ||
disposeAsset():void | Object3D | ||
disposeWithChildren():void
Disposes the current ObjectContainer3D including all of its children. | ObjectContainer3D | ||
getChildAt(index:uint):ObjectContainer3D
Retrieves the child object at the given index. | ObjectContainer3D | ||
Gets a concrete EntityPartition3DNode subclass that is associated with this Entity instance
| Entity | ||
getIndexBuffer(stage3DProxy:Stage3DProxy):IndexBuffer3D | SegmentSet | ||
getRenderSceneTransform(camera:Camera3D):Matrix3D | SegmentSet | ||
getSegment(index:uint):Segment | SegmentSet | ||
isIntersectingRay(rayPosition:Vector3D, rayDirection:Vector3D):Boolean | Entity | ||
lookAt(target:Vector3D, upAxis:Vector3D = null):void [override]
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D. | ObjectContainer3D | ||
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
| Object3D | ||
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
| Object3D | ||
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
| Object3D | ||
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
| Object3D | ||
movePivot(dx:Number, dy:Number, dz:Number):void
Moves the local point around which the object rotates. | Object3D | ||
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
| Object3D | ||
moveTo(dx:Number, dy:Number, dz:Number):void
Moves the 3d object directly to a point in space
| Object3D | ||
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
| Object3D | ||
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
| Object3D | ||
removeAllSegments():void
Empties the segmentSet from all its segments data
| SegmentSet | ||
removeChild(child:ObjectContainer3D):void
Removes a 3d object from the child array of the container
| ObjectContainer3D | ||
removeChildAt(index:uint):void
Removes a 3d object from the child array of the container
| ObjectContainer3D | ||
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void [override] | ObjectContainer3D | ||
removeSegment(segment:Segment, dispose:Boolean = false):void
Removes a segment from the SegmentSet. | SegmentSet | ||
removeSegmentByIndex(index:uint, dispose:Boolean = false):void
Removes a segment from the SegmentSet by its index in the set. | SegmentSet | ||
resetAssetPath(name:String, ns:String = null, overrideOriginal:Boolean = true):void | NamedAssetBase | ||
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
| Object3D | ||
rotate(axis:Vector3D, angle:Number):void [override] | ObjectContainer3D | ||
rotateTo(ax:Number, ay:Number, az:Number):void
Rotates the 3d object directly to a euler angle
| Object3D | ||
scale(value:Number):void
Appends a uniform scale to the current transformation. | Object3D | ||
translate(axis:Vector3D, distance:Number):void
Moves the 3d object along a vector by a defined length
| Object3D | ||
translateLocal(axis:Vector3D, distance:Number):void [override] | ObjectContainer3D | ||
updateImplicitVisibility():void | ObjectContainer3D | ||
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
| Object3D |
Method | Defined By | ||
---|---|---|---|
[override]
Factory method that returns the current partition node. | SegmentSet | ||
[override]
Creates the default bounding box to be used by this type of Entity. | SegmentSet | ||
invalidateBounds():void
Invalidates the bounding volume, causing to be updated when requested. | Entity | ||
invalidateSceneTransform():void [override]
Invalidates the scene transformation matrix, causing it to be updated the next time it's requested. | Entity | ||
updateBounds():void [override]
Updates the bounding volume for the object. | SegmentSet | ||
updateMouseChildren():void [override] | Entity | ||
updateSceneTransform():void
Updates the scene transformation matrix. | ObjectContainer3D | ||
updateTransform():void | Object3D |
_segments | property |
protected var _segments:Dictionary
animator | property |
assetType | property |
assetType:String
[read-only] [override] public function get assetType():String
castsShadows | property |
castsShadows:Boolean
[read-only] public function get castsShadows():Boolean
hasData | property |
hasData:Boolean
[read-only] arcane function get hasData():Boolean
indexData | property |
indexData:Vector.<uint>
[read-only] public function get indexData():Vector.<uint>
material | property |
material:MaterialBase
public function get material():MaterialBase
public function set material(value:MaterialBase):void
mouseEnabled | property |
mouseEnabled:Boolean
[override] Indicates whether the IRenderable should trigger mouse events, and hence should be rendered for hit testing.
public function get mouseEnabled():Boolean
public function set mouseEnabled(value:Boolean):void
numTriangles | property |
numTriangles:uint
[read-only] public function get numTriangles():uint
numVertices | property |
numVertices:uint
[read-only] public function get numVertices():uint
segmentCount | property |
segmentCount:uint
[read-only]
public function get segmentCount():uint
sourceEntity | property |
subSetCount | property |
subSetCount:uint
[read-only] arcane function get subSetCount():uint
UVData | property |
UVData:Vector.<Number>
[read-only] public function get UVData():Vector.<Number>
uvTransform | property |
uvTransform:Matrix
[read-only] public function get uvTransform():Matrix
vertexData | property |
vertexData:Vector.<Number>
[read-only] public function get vertexData():Vector.<Number>
vertexNormalData | property |
vertexNormalData:Vector.<Number>
[read-only] public function get vertexNormalData():Vector.<Number>
vertexNormalOffset | property |
vertexNormalOffset:int
[read-only] public function get vertexNormalOffset():int
vertexOffset | property |
vertexOffset:int
[read-only] public function get vertexOffset():int
vertexStride | property |
vertexStride:uint
[read-only] public function get vertexStride():uint
vertexTangentData | property |
vertexTangentData:Vector.<Number>
[read-only] public function get vertexTangentData():Vector.<Number>
vertexTangentOffset | property |
vertexTangentOffset:int
[read-only] public function get vertexTangentOffset():int
SegmentSet | () | Constructor |
public function SegmentSet()
Creates a new SegmentSet object.
activateSecondaryUVBuffer | () | method |
public function activateSecondaryUVBuffer(index:int, stage3DProxy:Stage3DProxy):void
Parameters
index:int | |
stage3DProxy:Stage3DProxy |
activateUVBuffer | () | method |
public function activateUVBuffer(index:int, stage3DProxy:Stage3DProxy):void
Parameters
index:int | |
stage3DProxy:Stage3DProxy |
activateVertexBuffer | () | method |
public function activateVertexBuffer(index:int, stage3DProxy:Stage3DProxy):void
Parameters
index:int | |
stage3DProxy:Stage3DProxy |
activateVertexNormalBuffer | () | method |
public function activateVertexNormalBuffer(index:int, stage3DProxy:Stage3DProxy):void
Parameters
index:int | |
stage3DProxy:Stage3DProxy |
activateVertexTangentBuffer | () | method |
public function activateVertexTangentBuffer(index:int, stage3DProxy:Stage3DProxy):void
Parameters
index:int | |
stage3DProxy:Stage3DProxy |
addSegment | () | method |
public function addSegment(segment:Segment):void
Adds a new segment to the SegmentSet.
Parameters
segment:Segment — the segment to add
|
createEntityPartitionNode | () | method |
override protected function createEntityPartitionNode():EntityNode
Factory method that returns the current partition node. Needs to be overridden by concrete subclasses such as Mesh to return the correct concrete subtype of EntityPartition3DNode (for Mesh = MeshPartition3DNode, most IRenderables (particles fe) would return RenderablePartition3DNode, I suppose)
ReturnsEntityNode |
dispose | () | method |
override public function dispose():void
Cleans up resources used by this asset.
getDefaultBoundingVolume | () | method |
override protected function getDefaultBoundingVolume():BoundingVolumeBase
Creates the default bounding box to be used by this type of Entity.
ReturnsBoundingVolumeBase — |
getIndexBuffer | () | method |
public function getIndexBuffer(stage3DProxy:Stage3DProxy):IndexBuffer3D
Parameters
stage3DProxy:Stage3DProxy |
IndexBuffer3D |
getRenderSceneTransform | () | method |
public function getRenderSceneTransform(camera:Camera3D):Matrix3D
Parameters
camera:Camera3D |
Matrix3D |
getSegment | () | method |
removeAllSegments | () | method |
public function removeAllSegments():void
Empties the segmentSet from all its segments data
removeSegment | () | method |
public function removeSegment(segment:Segment, dispose:Boolean = false):void
Removes a segment from the SegmentSet.
Parameters
segment:Segment — The segment to remove
| |
dispose:Boolean (default = false ) — If the segment must be disposed as well. Default is false;
|
removeSegmentByIndex | () | method |
public function removeSegmentByIndex(index:uint, dispose:Boolean = false):void
Removes a segment from the SegmentSet by its index in the set.
Parameters
index:uint — The index of the segment to remove
| |
dispose:Boolean (default = false ) — If the segment must be disposed as well. Default is false;
Removing a Segment by an index when segment is unknown
index of the segment is relative to the order it was added to the segmentSet.
If a segment was removed from or added to the segmentSet, a segment index may have changed.
The index of each Segment is updated when one is added or removed.
If 2 segments are added, segment #1 has index 0, segment #2 has index 1
if segment #1 is removed, segment#2 will get index 0 instead of 1.
|
updateBounds | () | method |
override protected function updateBounds():void
Updates the bounding volume for the object. Overriding methods need to set invalid flag to false!
updateSegment | () | method |