Property | Defined By | ||
---|---|---|---|
depth : Number [read-only] | ViewVolume | ||
height : Number [read-only] | ViewVolume | ||
maxBound : Vector3D [read-only] | ViewVolume | ||
maxX : Number [read-only] | ViewVolume | ||
maxY : Number [read-only] | ViewVolume | ||
maxZ : Number [read-only] | ViewVolume | ||
minBound : Vector3D [read-only] | ViewVolume | ||
minX : Number [read-only] | ViewVolume | ||
minY : Number [read-only] | ViewVolume | ||
minZ : Number [read-only] | ViewVolume | ||
numCellsX : uint [read-only] | ViewVolume | ||
numCellsY : uint [read-only] | ViewVolume | ||
numCellsZ : uint [read-only] | ViewVolume | ||
parent : NodeBase [read-only]
The parent node. | NodeBase | ||
showDebugBounds : Boolean | NodeBase | ||
width : Number [read-only] | ViewVolume |
Method | Defined By | ||
---|---|---|---|
ViewVolume(minBound:Vector3D, maxBound:Vector3D, cellSize:Number = -1)
Creates a new ViewVolume with given dimensions. | ViewVolume | ||
acceptTraverser(traverser:PartitionTraverser):void [override] | ViewVolume | ||
addVisibleDynamicCell(cell:InvertedOctreeNode, indexX:uint = 0, indexY:uint = 0, indexZ:uint = 0):void | ViewVolume | ||
addVisibleRegion(minBounds:Vector3D, maxBounds:Vector3D, scene:Scene3D, dynamicGrid:DynamicGrid = null, indexX:uint = 0, indexY:uint = 0, indexZ:uint = 0):void
Adds all static geometry in a scene that intersects a given region, as well as the dynamic grid if provided. | ViewVolume | ||
addVisibleStatic(entity:Entity, indexX:uint = 0, indexY:uint = 0, indexZ:uint = 0):void | ViewVolume | ||
A shortcut method for addVisibleRegion, that adds static geometry in a scene that intersects a given viewvolume, as well as the dynamic grid if provided. | ViewVolume | ||
contains(entryPoint:Vector3D):Boolean | ViewVolume | ||
Finds the partition that contains (or should contain) the given entity. | NodeBase | ||
isInFrustum(planes:Vector.<Plane3D>, numPlanes:int):Boolean
Tests if the current node is at least partly inside the frustum. | NodeBase | ||
isIntersectingRay(rayPosition:Vector3D, rayDirection:Vector3D):Boolean
Tests if the current node is intersecting with a ray. | NodeBase | ||
markCellAccessible(indexX:uint, indexY:uint, indexZ:uint):void
Enable the use of a cell. | ViewVolume | ||
markCellInaccessible(indexX:uint, indexY:uint, indexZ:uint):void
Disables the use of a cell. | ViewVolume | ||
removeVisibleDynamicCell(cell:InvertedOctreeNode, indexX:uint = 0, indexY:uint = 0, indexZ:uint = 0):void | ViewVolume | ||
removeVisibleStatic(entity:Entity, indexX:uint = 0, indexY:uint = 0, indexZ:uint = 0):void | ViewVolume |
Method | Defined By | ||
---|---|---|---|
[override] | ViewVolume | ||
updateNumEntities(value:int):void | NodeBase |
_active | property |
arcane var _active:Boolean
depth | property |
depth:Number
[read-only] public function get depth():Number
height | property |
height:Number
[read-only] public function get height():Number
maxBound | property |
maxBound:Vector3D
[read-only] public function get maxBound():Vector3D
maxX | property |
maxX:Number
[read-only] public function get maxX():Number
maxY | property |
maxY:Number
[read-only] public function get maxY():Number
maxZ | property |
maxZ:Number
[read-only] public function get maxZ():Number
minBound | property |
minBound:Vector3D
[read-only] public function get minBound():Vector3D
minX | property |
minX:Number
[read-only] public function get minX():Number
minY | property |
minY:Number
[read-only] public function get minY():Number
minZ | property |
minZ:Number
[read-only] public function get minZ():Number
numCellsX | property |
numCellsX:uint
[read-only] public function get numCellsX():uint
numCellsY | property |
numCellsY:uint
[read-only] public function get numCellsY():uint
numCellsZ | property |
numCellsZ:uint
[read-only] public function get numCellsZ():uint
width | property |
width:Number
[read-only] public function get width():Number
ViewVolume | () | Constructor |
public function ViewVolume(minBound:Vector3D, maxBound:Vector3D, cellSize:Number = -1)
Creates a new ViewVolume with given dimensions. A ViewVolume is a region where the camera or a shadow casting light could reside in.
ParametersminBound:Vector3D — The minimum boundaries of the view volume (the bottom-left-near corner)
| |
maxBound:Vector3D — The maximum boundaries of the view volume (the top-right-far corner)
| |
cellSize:Number (default = -1 ) — The size of cell subdivisions for the view volume. The default value is -1, meaning the view volume will not be subdivided. This is the value that should usually be used when setting visibility info manually.
|
acceptTraverser | () | method |
override public function acceptTraverser(traverser:PartitionTraverser):void
Parameters
traverser:PartitionTraverser |
addVisibleDynamicCell | () | method |
public function addVisibleDynamicCell(cell:InvertedOctreeNode, indexX:uint = 0, indexY:uint = 0, indexZ:uint = 0):void
Parameters
cell:InvertedOctreeNode | |
indexX:uint (default = 0 )
| |
indexY:uint (default = 0 )
| |
indexZ:uint (default = 0 )
|
addVisibleRegion | () | method |
public function addVisibleRegion(minBounds:Vector3D, maxBounds:Vector3D, scene:Scene3D, dynamicGrid:DynamicGrid = null, indexX:uint = 0, indexY:uint = 0, indexZ:uint = 0):void
Adds all static geometry in a scene that intersects a given region, as well as the dynamic grid if provided.
Parameters
minBounds:Vector3D — The minimum bounds of the region to be considered visible
| |
maxBounds:Vector3D — The maximum bounds of the region to be considered visible
| |
scene:Scene3D — The Scene3D object containing the static objects to be added.
| |
dynamicGrid:DynamicGrid (default = null ) — The DynamicGrid belonging to the partition this will be used with
| |
indexX:uint (default = 0 ) — An optional index for the cell within ViewVolume. If created with gridSize -1, this is typically avoided.
| |
indexY:uint (default = 0 ) — An optional index for the cell within ViewVolume. If created with gridSize -1, this is typically avoided.
| |
indexZ:uint (default = 0 ) — An optional index for the cell within ViewVolume. If created with gridSize -1, this is typically avoided.
|
addVisibleStatic | () | method |
public function addVisibleStatic(entity:Entity, indexX:uint = 0, indexY:uint = 0, indexZ:uint = 0):void
Parameters
entity:Entity | |
indexX:uint (default = 0 )
| |
indexY:uint (default = 0 )
| |
indexZ:uint (default = 0 )
|
addVisibleViewVolume | () | method |
public function addVisibleViewVolume(viewVolume:ViewVolume, scene:Scene3D, dynamicGrid:DynamicGrid = null):void
A shortcut method for addVisibleRegion, that adds static geometry in a scene that intersects a given viewvolume, as well as the dynamic grid if provided.
Parameters
viewVolume:ViewVolume — The viewVolume providing the region
| |
scene:Scene3D — The Scene3D object containing the static objects to be added.
| |
dynamicGrid:DynamicGrid (default = null ) — The DynamicGrid belonging to the partition this will be used with
|
contains | () | method |
public function contains(entryPoint:Vector3D):Boolean
Parameters
entryPoint:Vector3D |
Boolean |
createDebugBounds | () | method |
markCellAccessible | () | method |
public function markCellAccessible(indexX:uint, indexY:uint, indexZ:uint):void
Enable the use of a cell. Do this if the camera or casting light can potentially be in this cell. If the ViewVolume was constructed with gridSize -1, it does not need to be called
Parameters
indexX:uint — The x-index of the cell
| |
indexY:uint — The y-index of the cell
| |
indexZ:uint — The z-index of the cell
|
markCellInaccessible | () | method |
public function markCellInaccessible(indexX:uint, indexY:uint, indexZ:uint):void
Disables the use of a cell. Do this only if the camera or casting light can never be in this cell.
Parameters
indexX:uint — The x-index of the cell
| |
indexY:uint — The y-index of the cell
| |
indexZ:uint — The z-index of the cell
|
removeVisibleDynamicCell | () | method |
public function removeVisibleDynamicCell(cell:InvertedOctreeNode, indexX:uint = 0, indexY:uint = 0, indexZ:uint = 0):void
Parameters
cell:InvertedOctreeNode | |
indexX:uint (default = 0 )
| |
indexY:uint (default = 0 )
| |
indexZ:uint (default = 0 )
|
removeVisibleStatic | () | method |
public function removeVisibleStatic(entity:Entity, indexX:uint = 0, indexY:uint = 0, indexZ:uint = 0):void
Parameters
entity:Entity | |
indexX:uint (default = 0 )
| |
indexY:uint (default = 0 )
| |
indexZ:uint (default = 0 )
|