Packagealternativa.engine3d.objects
Classpublic class LOD
InheritanceLOD Inheritance Object3D Inheritance Object

Levels of detail is an Object3D which can have several representation of different detail level. The current level will be chosen for the rendering according to distance to the camera.



Public Properties
 PropertyDefined By
 InheritedboundBox : BoundBox
Bounds of the object described as rectangular parallelepiped.
Object3D
 InheritedconcatenatedMatrix : Matrix3D
[read-only] A Matrix3D object representing the combined transformation matrices of the Object3D and all of its parent objects, back to the root level.
Object3D
 InheriteddoubleClickEnabled : Boolean = false
Specifies whether the object receives doubleClick events.
Object3D
 InheritedexcludedLights : Vector.<Light3D>
[read-only] Returns excluded lights list of current object.
Object3D
 Inheritedmatrix : Matrix3D
The matrix property represents a transformation matrix that determines the position and orientation of an Object3D.
Object3D
 InheritedmouseChildren : Boolean = true
Determines whether or not the children of the object are mouse, or user input device, enabled.
Object3D
 InheritedmouseEnabled : Boolean = true
Specifies whether this object receives mouse, or other user input, messages.
Object3D
 Inheritedname : String
Name of the object.
Object3D
 InheritednumChildren : int
[read-only] Returns the number of children of this object.
Object3D
  numLevels : int
[read-only] Number of levels of detail.
LOD
 Inheritedparent : Object3D
[read-only] Object3D, to which this object was added as a child.
Object3D
 InheritedrotationX : Number
The angle of rotation of Object3D around the X-axis expressed in radians.
Object3D
 InheritedrotationY : Number
The angle of rotation of Object3D around the Y-axis expressed in radians.
Object3D
 InheritedrotationZ : Number
The angle of rotation of Object3D around the Z-axis expressed in radians.
Object3D
 InheritedscaleX : Number
The scale of the Object3D along the X-axis.
Object3D
 InheritedscaleY : Number
The scale of the Object3D along the Y-axis.
Object3D
 InheritedscaleZ : Number
The scale of the Object3D along the Z-axis.
Object3D
 InheriteduseHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls over a Object3D.
Object3D
 InheriteduserData : Object
Custom data available to store within Object3D by user.
Object3D
 Inheritedvisible : Boolean = true
Whether or not the display object is visible.
Object3D
 Inheritedx : Number
X coordinate.
Object3D
 Inheritedy : Number
Y coordinate.
Object3D
 Inheritedz : Number
Z coordinate.
Object3D
Public Methods
 MethodDefined By
 Inherited
Adds given Object3D instance as a child to the end of this Object3D's children list.
Object3D
 Inherited
addChildAt(child:Object3D, index:int):Object3D
Adds a child Object3D instance to this Object3D instance.
Object3D
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
Object3D
  
addLevel(level:Object3D, distance:Number):Object3D
Adds a children as a new level of detail.
LOD
 Inherited
Calculates object's bounds in its own coordinates
Object3D
 Inherited
clearExcludedLights(updateChildren:Boolean = false):void
Resets list of lights excluded from lighting this object.
Object3D
  
[override] Returns a copy of object.
LOD
 Inherited
contains(child:Object3D):Boolean
Check if given object is child of this Object3D.
Object3D
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
Object3D
 Inherited
excludeLight(light:Light3D, updateChildren:Boolean = false):void
Disables lighting of the object by given light.
Object3D
 Inherited
getChildAt(index:int):Object3D
Returns the child Object3D instance that exists at the specified index.
Object3D
 Inherited
Returns child Object3D instance with given name.
Object3D
 Inherited
Returns index of given child Object3D instance.
Object3D
  
getLevelByDistance(distance:Number):Object3D
Returns Object3D which was used as level of detail at given distance.
LOD
  
Returns Object3D which was used as level of detail with given name.
LOD
  
Returns distance was set up for the given level.
LOD
  
getLevels():Vector.<Object3D>
Returns all Object3Ds which was used as levels of detail in this LOD, in Vector.<Object3D>.
LOD
 Inherited
getResources(hierarchy:Boolean = false, resourceType:Class = null):Vector.<Resource>
Gather the resources of this Object3D.
Object3D
 Inherited
globalToLocal(point:Vector3D):Vector3D
Converts the Vector3D object from the root Object3D (global) coordinates to the local Object3D's own coordinates.
Object3D
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
Object3D
  
intersectRay(origin:Vector3D, direction:Vector3D):RayIntersectionData
[override] Searches for the intersection of an Object3D and given ray, defined by origin and direction.
LOD
 Inherited
localToGlobal(point:Vector3D):Vector3D
Converts the Vector3D object from the Object3D's own (local) coordinates to the root Object3D (global) coordinates.
Object3D
 Inherited
Removes the specified child Object3D instance from the child list of the this Object3D instance.
Object3D
 Inherited
Removes a child Object3D from the specified index position in the child list of the Object3D.
Object3D
 Inherited
removeChildren(beginIndex:int = 0, endIndex:int = 2147483647):void
Removes child objects in given range of indexes.
Object3D
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
Object3D
  
Removes level of detail.
LOD
 Inherited
setChildIndex(child:Object3D, index:int):void
Sets index for child Object3D instance.
Object3D
  
setLevelDistance(level:Object3D, distance:Number):void
Sets distance to the given level.
LOD
 Inherited
swapChildren(child1:Object3D, child2:Object3D):void
Swaps index positions of two specified child objects.
Object3D
 Inherited
swapChildrenAt(index1:int, index2:int):void
Swaps index positions of two child objects by its index.
Object3D
 Inherited
toString():String
Returns the string representation of the specified object.
Object3D
 Inherited
willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
Object3D
Protected Methods
 MethodDefined By
  
[override] Copies basic properties of Object3D.
LOD
Events
 Event Summary Defined By
 InheritedDispatches when an Object3D is added as a child to another Object3D.Object3D
 InheritedDispatched when a user presses and releases the main button of the user's pointing device over the same Object3D.Object3D
 InheritedDispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same Object3D.Object3D
 InheritedDispatched when a user presses and releases the middle button of the user's pointing device over the same Object3D.Object3D
 InheritedDispatched when a user presses the middle pointing device button over an Object3D instance.Object3D
 InheritedDispatched when a user releases the pointing device button over an Object3D instance.Object3D
 InheritedDispatched when a user presses the pointing device button over an Object3D instance.Object3D
 InheritedDispatched when a user moves the pointing device while it is over an Object3D.Object3D
 InheritedDispatched when the user moves a pointing device away from an Object3D instance.Object3D
 InheritedDispatched when the user moves a pointing device over an Object3D instance.Object3D
 InheritedDispatched when a user releases the pointing device button over an Object3D instance.Object3D
 InheritedDispatched when a mouse wheel is spun over an Object3D instance.Object3D
 InheritedDispatched when a Object3D is about to be removed from the children list.Object3D
 InheritedDispatched when a user presses and releases the right button of the user's pointing device over the same Object3D.Object3D
 InheritedDispatched when a user presses the right pointing device button over an Object3D instance.Object3D
 InheritedDispatched when a user releases the pointing device button over an Object3D instance.Object3D
 InheritedDispatched when the user moves a pointing device away from an Object3D instance.Object3D
 InheritedDispatched when the user moves a pointing device over an Object3D instance.Object3D
Property Detail
numLevelsproperty
numLevels:int  [read-only]

Number of levels of detail.


Implementation
    public function get numLevels():int
Method Detail
addLevel()method
public function addLevel(level:Object3D, distance:Number):Object3D

Adds a children as a new level of detail. In case of given object is a children of other Object3D already, it will removed from the previous place.

Parameters

level:Object3DObject3D which will added.
 
distance:Number — If the LOD closer to the camera than distance value, this level will be preferred to the distant one.

Returns
Object3D — Object, given as lod parameter.
clone()method 
override public function clone():Object3D

Returns a copy of object.

Returns
Object3D — A copy of this Object3D.
clonePropertiesFrom()method 
override protected function clonePropertiesFrom(source:Object3D):void

Copies basic properties of Object3D. This method calls from clone() method.

Parameters

source:Object3DObject3D, properties of which will be copied.

getLevelByDistance()method 
public function getLevelByDistance(distance:Number):Object3D

Returns Object3D which was used as level of detail at given distance.

Parameters

distance:Number — Distance.

Returns
Object3DObject3D which was used as level of detail at given distance.
getLevelByName()method 
public function getLevelByName(name:String):Object3D

Returns Object3D which was used as level of detail with given name.

Parameters

name:String — Name of the object.

Returns
Object3DObject3D with given name.
getLevelDistance()method 
public function getLevelDistance(level:Object3D):Number

Returns distance was set up for the given level. If the LOD closer to the camera than distance, this level will be preferred to the distant one.

Parameters

level:Object3D — Object3d which was used as level of detail.

Returns
Number — Distance was set up for the given level.
getLevels()method 
public function getLevels():Vector.<Object3D>

Returns all Object3Ds which was used as levels of detail in this LOD, in Vector.<Object3D>.

Returns
Vector.<Object3D>Vector.<Object3D> consists of Object3Ds which was used as levels of detail.
intersectRay()method 
override public function intersectRay(origin:Vector3D, direction:Vector3D):RayIntersectionData

Searches for the intersection of an Object3D and given ray, defined by origin and direction.

Parameters

origin:Vector3D — Origin of the ray.
 
direction:Vector3D — Direction of the ray.

Returns
RayIntersectionData — The result of searching given as RayIntersectionData. null will returned in case of intersection was not found.
removeLevel()method 
public function removeLevel(level:Object3D):Object3D

Removes level of detail.

Parameters

level:Object3D — Object3d which was used as level of detail that will be removed.

Returns
Object3D — The Object3d instance that you pass in the level parameter.

See also

setLevelDistance()method 
public function setLevelDistance(level:Object3D, distance:Number):void

Sets distance to the given level. If the LOD closer to the camera than distance value, this level will be preffered to the distant one.

Parameters

level:Object3D — Object3d which was used as level of detail.
 
distance:Number — Distance value.