Packagetwaver.threed.network
Classpublic class Overview
InheritanceOverview Inheritance Network3D Inheritance mx.core.UIComponent

Overview component is desigend to provide a top view of the 3D scene.



Public Properties
 PropertyDefined By
 InheritedalarmAttachmentEnableDyeFunction : Function
[write-only]
Network3D
 InheritedalarmColorFunction : Function
[write-only] Sets alarmColorFunction of a Network3D object.
Network3D
 InheritedalarmEffectFunction : Function
[write-only] Sets alarmEffectFunction of a Network3D obejct.
Network3D
 InheritedalarmEnableElementDyeFunction : Function
[write-only] Sets the alarmEnableElementDyeFunction of a Network3D object.
Network3D
 InheritedalarmEnableFunction : Function
[write-only]
Network3D
 InheritedancestorAllowMouse : Boolean
[write-only]
Network3D
 InheritedbackgroundAlpha : Number
[write-only] Specifies the alpha of the scene's background.
Network3D
 InheritedbackgroundColor : uint
[write-only] Specifies the color of the scene's background.
Network3D
 InheritedcalculateHeightFunction : Function
Sets the calculateHeightFunction of a Network3D object.
Network3D
 InheritedcameraDirection : Vector3D
[read-only] Gets the direction of the current camera.
Network3D
 InheritedcameraDistance : Number
Gets the distance between the orbit camrea and the pivot of the scene.
Network3D
 InheritedcameraMoveForwardStep : Number = 2
Defines the specified distance of the camera to move forward or backward.
Network3D
 InheritedcameraMoveSideStep : Number = 2
Defines the specified distance of the camera's sideways movement.
Network3D
 InheritedcameraPosition : Vector3D
Gets the position of the camrea.
Network3D
 InheritededtingPlane : String = xz
Defines on which plane users can drag and move the specified 3D objects.
Network3D
 InheritedelementBox : ElementBox
Gets the data container of a Network3D object.
Network3D
 InheritedenableChildSelected : Boolean
[write-only]
Network3D
 InheritedenableZoom : Boolean = true
Decides whether users can zoom in/out the scene with mouse.
Network3D
 InheritedeyeHeight : Number = 50
Defines the height of the avatar when developers using the first-person view.
Network3D
 InheritedfarLimit : Number
Gets the distance to the far plane from the frustum.
Network3D
 InheritedfogColor : uint
[write-only] Sets the color of the fog effect.
Network3D
 InheritedfogMaxDistance : Number
[write-only] Sets the maximum of the distance to the camera from the fog effect.
Network3D
 InheritedfogMinDistance : Number
[write-only] Sets the minimum of the distance to the camera from the fog effect.
Network3D
 Inheritedfov : Number
[read-only] Gets the field of view of the camera.
Network3D
 Inheritedfps : uint
[read-only] Gets current frame rate in FPS(Frames per second).
Network3D
 InheritednearLimit : Number
Gets the distance to the near plane from the frustum.
Network3D
 InheritedpanAngle : Number
Gets the pan angle of the camera in degrees.
Network3D
 InheritedpanAngleLowLimit : Number
Gets the minimum of the orbit camera's pan angle.
Network3D
 InheritedpanAngleUpLimit : Number
Gets the maximum of the orbit camera's pan angle.
Network3D
 InheritedpanWithMouse : Boolean = true
Decides whether users can pan the whole scene with mouse.
Network3D
 InheritedrenderLevel : int
[write-only] Defines the antialias ability of the Network3D object.
Network3D
 InheritedrotateWithKeyboard : Boolean = false
Network3D
 InheritedrotateWithKeyboardOffset : Number = 1
Network3D
 InheritedselectedColorFunction : Function
[write-only] Sets selectedColorFunction of a Network3D obejct.
Network3D
 InheritedselectedEffectFunction : Function
[write-only] Sets the selectedEffectFunction which will decorate the selected 3D object in the scene with delveopers' customation.
Network3D
 InheritedselectedWidthFunction : Function
[write-only] Sets selectedWidthFunction of a Network3D obejct.
Network3D
 InheritedselectionFunction : Function
Retrives the selectionFunction of a Network3D object.
Network3D
 Inheritedtarget : *
[write-only] Assigns the target which the camrea points to in the scene.
Network3D
 InheritedtiltAngle : Number
Gets the tilt angle of the camera in degrees.
Network3D
 InheritedtiltAngleLowLimit : Number
Gets the minimum of the camera's tilt angle.
Network3D
 InheritedtiltAngleUpLimit : Number
Gets the maximum of the camera's tilt angle.
Network3D
 InheritedtiltWithMouse : Boolean = true
Decides whether users can tilt the whole scene with mouse.
Network3D
 InheritedvalidateLocationFunction : Function
Gets current validateLocationFunction of a Network3D obejct.
Network3D
 InheritedvisibleFunction : Function
Gets current visibleFunction of a Network3D object.
Network3D
 InheritedzoomStep : Number = 8
Defines the zoom step.
Network3D
Public Methods
 MethodDefined By
  
Overview(network:Network3D, w:int, h:int)
Constructor.
Overview
 Inherited
Adds a light into the scene.
Network3D
 Inherited
addMouseOnCanvasListener(type:String, listener:Function):void
Network3D
 Inherited
addMouseOnElementListener(type:String, listener:Function):void
Network3D
 Inherited
applyCommonCamera(pos:Vector3D, panAngle:Number = 180, tiltAngle:Number = 90):void
Applies the first-person view in the scene.
Network3D
 Inherited
applyDragCamera(panAngle:Number = -180, tiltAngle:Number = 10, distance:Number = 500):void
Applies the orbit camera on the scene.
Network3D
 Inherited
applyHoverCamera(panAngle:Number = -180, tiltAngle:Number = 10, distance:Number = 500):void
Applies the orbit camera on the scene.
Network3D
 Inherited
Clears all the lights in the scene.
Network3D
 Inherited
dispose():void
Releases the resource occupied by a Network3D object, especially the Stage3D resource.
Network3D
 Inherited
Gets all the names of the animations defined in external model files.
Network3D
 Inherited
Retrives the enviroment element's id.
Network3D
 Inherited
getHeightAt(x:Number, z:Number):Number
Gets the y value by specifing the x and z coordinate according the terrain of the scene.
Network3D
 Inherited
Retrives the terrain element's id.
Network3D
 Inherited
hideAxises():void
Hides the axises in the scene.
Network3D
 Inherited
isValidatedLocation(x:Number, y:Number, z:Number):Boolean
Decides whether the camera can be moved to the specified postion described by x, y and z coordinates.
Network3D
 Inherited
isVisible(element:Element):Boolean
Decides whether a twaver.Element can be seen in the 3D scene.
Network3D
 Inherited
refreshUIs():void
Network3D
 Inherited
removeLight(tag:String):void
Removes a light from the scene by specifing its tag.
Network3D
 Inherited
removeMouseOnCanvasListener(type:String, listener:Function):void
Network3D
 Inherited
removeMouseOnElementListener(type:String, listener:Function):void
Network3D
 Inherited
saveAsBitmapData():BitmapData
Exports the current visible scene to a BitmapData object.
Network3D
 Inherited
scrafe(d:Number):void
Network3D
 Inherited
setEnviromentByID(id:Object):void
Specifies which element is used as the enviroment.
Network3D
 Inherited
setReferenceTerrainByID(id:Object):void
Specifies which element is used as the terrain.
Network3D
 Inherited
Shares the whole 3D scene with another Network3D object.
Network3D
 Inherited
showAxises():void
Displays the axises in the scene.
Network3D
 Inherited
Updates the properties of a light which has been added into the scene.
Network3D
 Inherited
walk(d:Number):void
Network3D
Protected Methods
 MethodDefined By
 Inherited
setInteractions(name:String, interactions:Array):void
Network3D
Constructor Detail
Overview()Constructor
public function Overview(network:Network3D, w:int, h:int)

Constructor.

Parameters
network:Network3D — Network3D instance, which shares the scene with the Overview component.
 
w:int — int the width of the Overview component.
 
h:int — int the height of the Overview component.

Example
         var overview:Overview = new Overview(network,128,128);
         overview.x = 10;
         overview.y = 10;
         network.addChild(overview);