class WMParams

Available on all platforms

Container for the parameters used in wm3d. Almost all variables are referenced by parent class, Watermelon Thus, most variables should be defined as public.

Variables in this class may not be modified by standard usage unlike those in WMStates.

Instance Fields

var arDegree:Float

auto-rotation degrees per frame

var dcActive:Bool

is depth cueing active?

var dcCoeff:Float

depth cueing coefficient

var dcLength:Float

depth cueing characteristic length

var depthWheel:Float

unit length for camera position translation

var doAutoScale:Bool

whether activate auto scaling when loading

var doCulling:Bool

culling

var inheritScale:Bool

whether inherit scaling parameter from the first SCENE

var mouseMoveRotatScale:Float

coefficient for rotation degrees in mouse dragging (only in rotation mode)

var mouseMoveScaleScale:Float

coefficient for scaling in mouse dragging (only in scale mode)

var numFramesPerScene:Int

number of frames displayed for a scene this value is determined by the framerate of the flash and framerate of playFrameRate variable.

var playFrameRate:Float

framerate for playing; meaningful only if there are multiple scenes

var protectData:Bool

Whether disable, saving, editing xml data.

var readBackground:Bool

whether read molecules in the background

var scaleFactorAuto:Float

coordinate auto-scaling coefficient

var scaleFactorManual:Float

coodrinate manually scaling factor

var scaleWheel:Float

mouse wheel scaling coefficient

var traceColor:Int

debug message color

function new(w:Watermelon):Void

Constructor.

Default values:

  • doCulling; true
  • traceColor: 0xFF0000
  • arDegree: 1.5
  • scaleWheel: 0.01
  • depthWheel: 0.04 * max( stageWidth, stageHeight )
  • playFrameRate: 3.0 // 3 frames per sec (at most)
  • mouseMoveRotatScale: 30.0
  • mouseMoveScaleScale: 15.0
  • protectData: false
  • readBackground: false
  • numFramesPerScene: -1
  • inheritScale: true
  • doAutoScale: true
  • scaleFactorAuto: 0.3
  • scaleFactorManual: 10.0
  • dcActive: true
  • dcCoeff: 4.0 / min( stageWidth, stageHeight )
  • dcLength: -0.2 * min( stageWidth, stageHeight )

function assignNumFramesPerScene():Void

actual setter of numFramesPerScene

function get_arDegree():Float

getter of arDegree

function get_dcActive():Bool

getter of dcActive

function get_dcCoeff():Float

getter of dcCoeff

function get_dcLength():Float

getter of dcLength

function get_depthWheel():Float

getter for depthWheel

function get_doAutoScale():Bool

getter for doAutoScale

function get_doCulling():Bool

getter for doCulling

function get_inheritScale():Bool

getter of inheritScale

function get_mouseMoveRotatScale():Float

getter of mouseMoveRotatScale

function get_mouseMoveScaleScale():Float

getter of mouseMoveScaleScale

function get_numFramesPerScene():Int

getter of numFramesPerScene

function get_playFrameRate():Float

getter of playFrameRate

function get_protectData():Bool

getter for protectData

function get_readBackground():Bool

getter of readBackground

function get_scaleFactorAuto():Float

getter for scaleFactorAuto

function get_scaleFactorManual():Float

getter of scaleFactorManual

function get_scaleWheel():Float

getter of scaleWheel

function get_traceColor():Int

getter for traceColor

function set_arDegree(d:Float):Float

setter of arDegree

function set_dcActive(a:Bool):Bool

setter of dcActive

function set_dcCoeff(c:Float):Float

setter of dcCoeff

function set_dcLength(l:Float):Float

setter of dcLength

function set_depthWheel(f:Float):Float

setter for depthWheel

function set_doAutoScale(f:Bool):Bool

setter for doAutoScale

function set_doCulling(c:Bool):Bool

setter for doCulling

function set_inheritScale(f:Bool):Bool

setter of inheritScale

function set_mouseMoveRotatScale(s:Float):Float

setter of mouseMoveRotatScale

function set_mouseMoveScaleScale(s:Float):Float

setter of mouseMoveScaleScale

function set_numFramesPerScene(n:Int):Int

setter of numFramesPerScene

function set_playFrameRate(r:Float):Float

setter of playFrameRate

function set_protectData(f:Bool):Bool

setter for protectData

function set_readBackground(f:Bool):Bool

setter of readBackground

function set_scaleFactorAuto(f:Float):Float

setter for scaleFactorAuto

function set_scaleFactorManual(f:Float):Float

setter of scaleFactorManual

function set_scaleWheel(s:Float):Float

setter of scaleWheel

function set_traceColor(c:Int):Int

setter for traceColor