dojox/gfx3d/object.js

• Provides:

  • dojox.gfx3d.object

• Requires:

  • dojox.gfx in common
  • dojox.gfx3d.lighting in common
  • dojox.gfx3d.scheduler in common
  • dojox.gfx3d.vector in common
  • dojox.gfx3d.gradient in common

• dojox.gfx3d.Viewport

  • type

    Function

  • chains:
    • dojox.gfx3d._creators: (prototype)
    • dojox.gfx.Group: (prototype)
    • dojox.gfx.Group: (call)
  • summary

    a viewport/container for 3D objects, which knows
    the camera and lightings

• dojox.gfx3d.Scene

  • type

    Function

  • chains:
    • dojox.gfx3d._creators: (prototype)
    • dojox.gfx3d.Object: (prototype)
    • dojox.gfx3d.Object: (call)
  • summary

    the Scene is just a containter.
    note: we have the following assumption:
    all objects in the Scene are not overlapped with other objects
    outside of the scene.

• dojox.gfx.Surface

  • type

    Function

• dojox.gfx.Surface.createViewport

  • type

    Function

• dojox.gfx3d.Object

  • type

    Function

  • summary

    a Object object, which knows how to map
    3D objects to 2D shapes.

• dojox.gfx3d.Object.constructor

  • constructor - constructor
  • type

    Function

  • summary

    a Object object, which knows how to map
    3D objects to 2D shapes.

• dojox.gfx3d.Object.setObject

  • parameters:
    • newObject
  • summary

    sets a Object object

  • type

    Function

• dojox.gfx3d.Object.object

  • type

    Object:

  • summary

    an abstract Object object
    (see dojox.gfx3d.defaultEdges,
    dojox.gfx3d.defaultTriangles,
    dojox.gfx3d.defaultQuads
    dojox.gfx3d.defaultOrbit
    dojox.gfx3d.defaultCube
    or dojox.gfx3d.defaultCylinder)

• dojox.gfx3d.Object.setObject.object

  • type

    Object:

  • summary

    an abstract Object object
    (see dojox.gfx3d.defaultEdges,
    dojox.gfx3d.defaultTriangles,
    dojox.gfx3d.defaultQuads
    dojox.gfx3d.defaultOrbit
    dojox.gfx3d.defaultCube
    or dojox.gfx3d.defaultCylinder)

• dojox.gfx3d.Object.setTransform

  • parameters:
    • matrix: (typeof dojox.gfx3d.matrix.Matrix:)

      a matrix or a matrix-like object
      (see an argument of dojox.gfx3d.matrix.Matrix
      constructor for a list of acceptable arguments)

  • returns

    self

  • summary

    sets a transformation matrix

  • type

    Function

• dojox.gfx3d.Object.matrix

  • type

    Object

• dojox.gfx3d.Object.setTransform.matrix

  • type

    dojox.gfx3d.matrix.Matrix:

  • summary

    a matrix or a matrix-like object
    (see an argument of dojox.gfx3d.matrix.Matrix
    constructor for a list of acceptable arguments)

• dojox.gfx3d.Object.applyRightTransform

  • parameters:
    • matrix: (typeof dojox.gfx3d.matrix.Matrix:)

      a matrix or a matrix-like object
      (see an argument of dojox.gfx.matrix.Matrix
      constructor for a list of acceptable arguments)

  • returns

    self

  • summary

    multiplies the existing matrix with an argument on right side
    (this.matrix * matrix)

  • type

    Function

• dojox.gfx3d.Object.applyLeftTransform

  • parameters:
    • matrix: (typeof dojox.gfx3d.matrix.Matrix:)

      a matrix or a matrix-like object
      (see an argument of dojox.gfx.matrix.Matrix
      constructor for a list of acceptable arguments)

  • returns

    self

  • summary

    multiplies the existing matrix with an argument on left side
    (matrix * this.matrix)

  • type

    Function

• dojox.gfx3d.Object.applyTransform

  • parameters:
    • matrix: (typeof dojox.gfx3d.matrix.Matrix:)

      a matrix or a matrix-like object
      (see an argument of dojox.gfx.matrix.Matrix
      constructor for a list of acceptable arguments)

  • returns

    self

  • summary

    a shortcut for dojox.gfx.Shape.applyRightTransform

  • type

    Function

• dojox.gfx3d.Object.setFill

  • parameters:
    • fill: (typeof Object:)

      a fill object
      (see dojox.gfx.defaultLinearGradient,
      dojox.gfx.defaultRadialGradient,
      dojox.gfx.defaultPattern,
      dojo.Color
      or dojox.gfx.MODEL)

  • summary

    sets a fill object
    (the default implementation is to delegate to
    the underlying 2D shape).

  • type

    Function

• dojox.gfx3d.Object.fillStyle

  • type

    Object

• dojox.gfx3d.Object.setStroke

  • parameters:
    • stroke: (typeof Object:)

      a stroke object
      (see dojox.gfx.defaultStroke)

  • summary

    sets a stroke object
    (the default implementation simply ignores it)

  • type

    Function

• dojox.gfx3d.Object.strokeStyle

  • type

    Object

• dojox.gfx3d.Object.toStdFill

  • parameters:
    • lighting
    • normal
  • type

    Function

• dojox.gfx3d.Object.invalidate

  • type

    Function

• dojox.gfx3d.Object.destroy

  • type

    Function

• dojox.gfx3d.Object.shape

  • type

    Object

• dojox.gfx3d.Object.render

  • parameters:
    • camera
  • type

    Function

• dojox.gfx3d.Object.draw

  • parameters:
    • lighting
  • type

    Function

• dojox.gfx3d.Object.getZOrder

  • type

    Function

• dojox.gfx3d.Object.getOutline

  • type

    Function

• dojox.gfx3d.Object.cache

  • type

    Object

• dojox.gfx3d.Object.renderer

  • type

    Object

• dojox.gfx3d.Object.parent

  • type

    Object

• dojox.gfx3d.Scene.constructor

  • constructor - constructor
  • type

    Function

  • summary

    a containter of other 3D objects

• dojox.gfx3d.Scene.setFill

  • parameters:
    • fill
  • type

    Function

• dojox.gfx3d.Scene.fillStyle

• dojox.gfx3d.Scene.setStroke

  • parameters:
    • stroke
  • type

    Function

• dojox.gfx3d.Scene.strokeStyle

• dojox.gfx3d.Scene.render

  • parameters:
    • camera
    • deep
  • type

    Function

• dojox.gfx3d.Scene.todos

  • type

    Array

• dojox.gfx3d.Scene.draw

  • parameters:
    • lighting
  • type

    Function

• dojox.gfx3d.Scene.objects

  • type

    Array

• dojox.gfx3d.Scene.addTodo

  • parameters:
    • newObject
  • type

    Function

• dojox.gfx3d.Scene.invalidate

  • type

    Function

• dojox.gfx3d.Scene.getZOrder

  • type

    Function

• dojox.gfx3d.Scene.schedule

• dojox.gfx3d.Scene._draw

• dojox.gfx3d.Edges

  • type

    Function

  • chains:
    • dojox.gfx3d.Object: (prototype)
    • dojox.gfx3d.Object: (call)
  • summary

    a generic edge in 3D viewport

• dojox.gfx3d.Edges.constructor

  • constructor - constructor
  • type

    Function

  • summary

    a generic edge in 3D viewport

• dojox.gfx3d.Edges.setObject

  • parameters:
    • newObject: (typeof Array)

      of points || Object

    • style: (typeof String,)

      optional

  • summary

    setup the object

  • type

    Function

• dojox.gfx3d.Edges.object

  • type

    Object

• dojox.gfx3d.Edges.getZOrder

  • type

    Function

• dojox.gfx3d.Edges.render

  • parameters:
    • camera
  • type

    Function

• dojox.gfx3d.Edges.cache

  • type

    Object

• dojox.gfx3d.Edges.draw

  • type

    Function

• dojox.gfx3d.Edges.shape

  • type

    Object

• dojox.gfx3d.Orbit

  • type

    Function

  • chains:
    • dojox.gfx3d.Object: (prototype)
    • dojox.gfx3d.Object: (call)
  • summary

    a generic edge in 3D viewport

• dojox.gfx3d.Orbit.constructor

  • constructor - constructor
  • type

    Function

  • summary

    a generic edge in 3D viewport

• dojox.gfx3d.Orbit.render

  • parameters:
    • camera
  • type

    Function

• dojox.gfx3d.Orbit.cache

  • type

    Object

• dojox.gfx3d.Orbit.draw

  • parameters:
    • lighting
  • type

    Function

• dojox.gfx3d.Orbit.shape

  • type

    Object

• dojox.gfx3d.Orbit.object

  • type

    Object

• dojox.gfx3d.Path3d

  • type

    Function

  • chains:
    • dojox.gfx3d.Object: (prototype)
    • dojox.gfx3d.Object: (call)
  • summary

    a generic line
    (this is a helper object, which is defined for convenience)

• dojox.gfx3d.Path3d.constructor

  • constructor - constructor
  • type

    Function

  • summary

    a generic line
    (this is a helper object, which is defined for convenience)

• dojox.gfx3d.Path3d._collectArgs

  • parameters:
    • array: (typeof Array:)

      an output argument (array of numbers)

    • args: (typeof Array:)

      an input argument (can be values of Boolean, Number, dojox.gfx.Point, or an embedded array of them)

  • summary

    converts an array of arguments to plain numeric values

  • type

    Function

• dojox.gfx3d.Path3d._validSegments

  • type

    Object

• dojox.gfx3d.Path3d._validSegments.m

  • type

    Number

• dojox.gfx3d.Path3d._validSegments.l

  • type

    Number

• dojox.gfx3d.Path3d._validSegments.z

  • type

    Number

• dojox.gfx3d.Path3d._pushSegment

  • parameters:
    • action: (typeof String:)

      valid SVG code for a segment's type

    • args: (typeof Array:)

      a list of parameters for this segment

  • summary

    adds a segment

  • type

    Function

• dojox.gfx3d.Path3d.moveTo

  • returns

    self

  • summary

    formes a move segment

  • type

    Function

• dojox.gfx3d.Path3d.lineTo

  • returns

    self

  • summary

    formes a line segment

  • type

    Function

• dojox.gfx3d.Path3d.closePath

  • returns

    self

  • summary

    closes a path

  • type

    Function

• dojox.gfx3d.Path3d.render

  • parameters:
    • camera
  • type

    Function

• dojox.gfx3d.Path3d.cache

• dojox.gfx3d.Path3d._draw

  • type

    Function

• dojox.gfx3d.Path3d.object

  • type

    Object

• dojox.gfx3d.Path3d.segments

  • type

    Array

• dojox.gfx3d.Path3d.absolute

  • type

    Object

• dojox.gfx3d.Path3d.last

  • type

    Object

• dojox.gfx3d.Path3d.path

  • type

    String

• dojox.gfx3d.Triangles

  • type

    Function

  • chains:
    • dojox.gfx3d.Object: (prototype)
    • dojox.gfx3d.Object: (call)
  • summary

    a generic triangle
    (this is a helper object, which is defined for convenience)

• dojox.gfx3d.Triangles.constructor

  • constructor - constructor
  • type

    Function

  • summary

    a generic triangle
    (this is a helper object, which is defined for convenience)

• dojox.gfx3d.Triangles.setObject

  • parameters:
    • newObject: (typeof Array)

      of points || Object

    • style: (typeof String,)

      optional

  • summary

    setup the object

  • type

    Function

• dojox.gfx3d.Triangles.object

  • type

    Object

• dojox.gfx3d.Triangles.render

  • parameters:
    • camera
  • type

    Function

• dojox.gfx3d.Triangles.cache

  • type

    Object

• dojox.gfx3d.Triangles.draw

  • parameters:
    • lighting
  • type

    Function

• dojox.gfx3d.Triangles.shape

  • type

    Object

• dojox.gfx3d.Triangles.getZOrder

  • type

    Function

• dojox.gfx3d.Quads

  • type

    Function

  • chains:
    • dojox.gfx3d.Object: (prototype)
    • dojox.gfx3d.Object: (call)
  • summary

    a generic triangle
    (this is a helper object, which is defined for convenience)

• dojox.gfx3d.Quads.constructor

  • constructor - constructor
  • type

    Function

  • summary

    a generic triangle
    (this is a helper object, which is defined for convenience)

• dojox.gfx3d.Quads.setObject

  • parameters:
    • newObject: (typeof Array)

      of points || Object

    • style: (typeof String,)

      optional

  • summary

    setup the object

  • type

    Function

• dojox.gfx3d.Quads.object

  • type

    Object

• dojox.gfx3d.Quads.render

  • parameters:
    • camera
  • type

    Function

• dojox.gfx3d.Quads.cache

  • type

    Object

• dojox.gfx3d.Quads.draw

  • parameters:
    • lighting
  • type

    Function

• dojox.gfx3d.Quads.shape

  • type

    Object

• dojox.gfx3d.Quads.getZOrder

  • type

    Function

• dojox.gfx3d.Polygon

  • type

    Function

  • chains:
    • dojox.gfx3d.Object: (prototype)
    • dojox.gfx3d.Object: (call)
  • summary

    a generic triangle
    (this is a helper object, which is defined for convenience)

• dojox.gfx3d.Polygon.constructor

  • constructor - constructor
  • type

    Function

  • summary

    a generic triangle
    (this is a helper object, which is defined for convenience)

• dojox.gfx3d.Polygon.setObject

  • parameters:
    • newObject: (typeof Array)

      of points || Object

  • summary

    setup the object

  • type

    Function

• dojox.gfx3d.Polygon.object

  • type

    Object

• dojox.gfx3d.Polygon.render

  • parameters:
    • camera
  • type

    Function

• dojox.gfx3d.Polygon.cache

  • type

    Object

• dojox.gfx3d.Polygon.draw

  • parameters:
    • lighting
  • type

    Function

• dojox.gfx3d.Polygon.shape

  • type

    Object

• dojox.gfx3d.Polygon.getZOrder

  • type

    Function

• dojox.gfx3d.Polygon.getOutline

  • type

    Function

• dojox.gfx3d.Cube

  • type

    Function

  • chains:
    • dojox.gfx3d.Object: (prototype)
    • dojox.gfx3d.Object: (call)
  • summary

    a generic triangle
    (this is a helper object, which is defined for convenience)

• dojox.gfx3d.Cube.constructor

  • constructor - constructor
  • type

    Function

  • summary

    a generic triangle
    (this is a helper object, which is defined for convenience)

• dojox.gfx3d.Cube.setObject

  • parameters:
    • newObject: (typeof Array)

      of points || Object

  • summary

    setup the object

  • type

    Function

• dojox.gfx3d.Cube.object

  • type

    Object

• dojox.gfx3d.Cube.render

  • parameters:
    • camera
  • type

    Function

• dojox.gfx3d.Cube.cache

  • type

    Object

• dojox.gfx3d.Cube.draw

  • parameters:
    • lighting
  • type

    Function

• dojox.gfx3d.Cube.shape

  • type

    Object

• dojox.gfx3d.Cube.getZOrder

  • type

    Function

• dojox.gfx3d.Cube.cache.0.0

• dojox.gfx3d.Cube.cache.1.2

• dojox.gfx3d.Cube.polygons

  • type

    Array

• dojox.gfx3d.Cylinder

  • type

    Function

  • chains:
    • dojox.gfx3d.Object: (prototype)
    • dojox.gfx3d.Object: (call)

• dojox.gfx3d.Cylinder.constructor

  • constructor - constructor
  • type

    Function

• dojox.gfx3d.Cylinder.render

  • parameters:
    • camera
  • type

    Function

• dojox.gfx3d.Cylinder.object.radius

  • type

    Object

• dojox.gfx3d.Cylinder.cache

  • type

    Object

• dojox.gfx3d.Cylinder.draw

  • type

    Function

• dojox.gfx3d.Cylinder.shape

  • type

    Object

• dojox.gfx3d.Cylinder.object

  • type

    Object

• dojox.gfx3d.Viewport.constructor

  • constructor - constructor
  • type

    Function

  • summary

    a viewport/container for 3D objects, which knows
    the camera and lightings

• dojox.gfx3d.Viewport.setCameraTransform

  • parameters:
    • matrix: (typeof dojox.gfx3d.matrix.Matrix:)

      a matrix or a matrix-like object
      (see an argument of dojox.gfx.matrix.Matrix
      constructor for a list of acceptable arguments)

  • returns

    self

  • summary

    sets a transformation matrix

  • type

    Function

• dojox.gfx3d.Viewport.camera

  • type

    Object

• dojox.gfx3d.Viewport.applyCameraRightTransform

  • parameters:
    • matrix: (typeof dojox.gfx3d.matrix.Matrix:)

      a matrix or a matrix-like object
      (see an argument of dojox.gfx3d.matrix.Matrix
      constructor for a list of acceptable arguments)

  • returns

    self

  • summary

    multiplies the existing matrix with an argument on right side
    (this.matrix * matrix)

  • type

    Function

• dojox.gfx3d.Viewport.applyCameraLeftTransform

  • parameters:
    • matrix: (typeof dojox.gfx3d.matrix.Matrix:)

      a matrix or a matrix-like object
      (see an argument of dojox.gfx3d.matrix.Matrix
      constructor for a list of acceptable arguments)

  • returns

    self

  • summary

    multiplies the existing matrix with an argument on left side
    (matrix * this.matrix)

  • type

    Function

• dojox.gfx3d.Viewport.applyCameraTransform

  • parameters:
    • matrix: (typeof dojox.gfx3d.matrix.Matrix:)

      a matrix or a matrix-like object
      (see an argument of dojox.gfx3d.matrix.Matrix
      constructor for a list of acceptable arguments)

  • returns

    self

  • summary

    a shortcut for dojox.gfx3d.Object.applyRightTransform

  • type

    Function

• dojox.gfx3d.Viewport.setLights

  • parameters:
    • lights: (typeof Array)

      Array: an array of light object
      or lights object

    • ambient: (typeof Color,)

      Color: an ambient object

    • specular: (typeof Color,)

      Color: an specular object

  • summary

    set the lights

  • type

    Function

• dojox.gfx3d.Viewport.lights

  • type

    Array

• dojox.gfx3d.Viewport.lighting

  • type

    Object

• dojox.gfx3d.Viewport.setLights.lights

  • type

    Array:

  • summary

    an array of light object
    or lights object
    ambient: Color: an ambient object
    specular: Color: an specular object

• dojox.gfx3d.Viewport.addLights

  • parameters:
    • lights: (typeof Array)

      || light object: light object(s)

  • summary

    add new light/lights to the viewport.

  • type

    Function

• dojox.gfx3d.Viewport.addTodo

  • parameters:
    • newObject
  • type

    Function

• dojox.gfx3d.Viewport.invalidate

  • type

    Function

• dojox.gfx3d.Viewport.deep

  • type

    bool

• dojox.gfx3d.Viewport.todos

  • type

    Array

• dojox.gfx3d.Viewport.setDimensions

  • parameters:
    • dim
  • type

    Function

• dojox.gfx3d.Viewport.rawNode.style

• dojox.gfx3d.Viewport.rawNode.style.height

• dojox.gfx3d.Viewport.rawNode.style.width

• dojox.gfx3d.Viewport.dimension

  • type

    Object:

  • summary

    the dimension of the canvas

• dojox.gfx3d.Viewport.render

  • summary

    iterate all children and call their render callback function.

  • type

    Function

• dojox.gfx3d.Viewport.objects

  • type

    Array

• dojox.gfx3d.Viewport.renderer

  • type

    Object

• dojox.gfx3d.Viewport.schedule

• dojox.gfx3d.Viewport.draw

• out

  • parameters:
    • o
    • x
  • type

    Function

• dojox.gfx3d.Viewport.nodeType

  • alias - dojox.gfx.Group.nodeType

• dojox.gfx3d._creators

  • summary

    object creators
    
    
    todo : override the add/remove if necessary

  • type

    Object

• dojox.gfx3d._creators.createEdges

  • parameters:
    • edges
    • style
  • returns

    dojox.gfx3d.Edge

  • summary

    creates an edge object
    line: Object: a edge object (see dojox.gfx3d.defaultPath)

  • type

    Function

• dojox.gfx3d._creators.createTriangles

  • parameters:
    • tris
    • style
  • returns

    dojox.gfx3d.Edge

  • summary

    creates an edge object
    line: Object: a edge object (see dojox.gfx3d.defaultPath)

  • type

    Function

• dojox.gfx3d._creators.createQuads

  • parameters:
    • quads
    • style
  • returns

    dojox.gfx3d.Edge

  • summary

    creates an edge object
    line: Object: a edge object (see dojox.gfx3d.defaultPath)

  • type

    Function

• dojox.gfx3d._creators.createPolygon

  • parameters:
    • points: (typeof Array)

      of points || Object

  • returns

    dojox.gfx3d.Polygon

  • summary

    creates an triangle object

  • type

    Function

• dojox.gfx3d._creators.createOrbit

  • parameters:
    • orbit
  • returns

    dojox.gfx3d.Cube

  • summary

    creates an triangle object
    points: Array of points || Object

  • type

    Function

• dojox.gfx3d._creators.createCube

  • parameters:
    • cube
  • returns

    dojox.gfx3d.Cube

  • summary

    creates an triangle object
    points: Array of points || Object

  • type

    Function

• dojox.gfx3d._creators.createCylinder

  • parameters:
    • cylinder
  • returns

    dojox.gfx3d.Cube

  • summary

    creates an triangle object
    points: Array of points || Object

  • type

    Function

• dojox.gfx3d._creators.createPath3d

  • parameters:
    • path
  • returns

    dojox.gfx3d.Edge

  • summary

    creates an edge object
    line: Object: a edge object (see dojox.gfx3d.defaultPath)

  • type

    Function

• dojox.gfx3d._creators.createScene

  • returns

    dojox.gfx3d.Scene

  • summary

    creates an triangle object
    line: Object: a triangle object (see dojox.gfx3d.defaultPath)

  • type

    Function

• dojox.gfx3d._creators.create3DObject

  • parameters:
    • objectType
    • rawObject
    • style
  • returns

    dojox.gfx3d.Object

  • summary

    creates an instance of the passed shapeType class
    shapeType: Function: a class constructor to create an instance of
    rawShape: Object: properties to be passed in to the classes "setShape" method

  • type

    Function

• dojox.gfx3d._creators.adopt

  • parameters:
    • obj
  • summary

    adds a shape to the list
    shape: dojox.gfx.Shape: a shape

  • type

    Function

• dojox.gfx3d._creators.abandon

  • parameters:
    • obj
    • silently: (typeof Boolean:)

      if true, do not redraw a picture yet

  • returns

    self

  • summary

    removes a shape from the list

  • type

    Function

• dojox.gfx3d._creators.setScheduler

  • parameters:
    • scheduler
  • type

    Function

• dojox.gfx3d._creators.setScheduler.schedule

• dojox.gfx3d._creators.setDrawer

  • parameters:
    • drawer
  • type

    Function

• dojox.gfx3d._creators.setDrawer.draw

• dojox.gfx3d.object

  • type

    Object

• dojox.gfx3d

  • type

    Object

• dojox

  • type

    Object