de.mirell.m3d

class C3DEngine

Object | +--de.mirell.m3d.C3DEngine

class C3DEngine extends Object
Core Class for the 3D Engine.
C3DEngine is a static class which keeps global information and is used to set one of the available renderers to be used.
The render method is called in order to have one frame rendered.
  • Author:
    Mirell Development
  • Version:
    1.0
  • Example:
    The following code shows a basic setup of a routine for rendering and how to use C3DEngine in it:
    // Skip two frames
    C3DEngine.frameskip = 2;
    // Assign the highest performance/lowest quality renderer
    C3DEngine.setRenderer((new CRendererFactory()).getRenderer(CRendererFactory.LOWEST));
    ...
    _root.onEnterFrame = function(): Void
    {
    	...
    	C3DEngine.render(myScene);
    }
    
  • See also:

Field Summary

public static frameskip: Number
Number of frames to skip
public static lightning: Number
Enable/Disable Lightning
public static logo: String
The Mirell 3D ASCII logo
public static name: String
Engine name
public static textures: Number
Enable/Disable Textures
public static version: String
Engine version

Method Summary

public static render ( Scene: CScene )
Renders a frame of the specified scene
public static setRenderer ( Renderer: Function ): Void
Assigns a renderer to use

Field Documentation

frameskip

public static var frameskip: Number
Number of frames to skip

    lightning

    public static var lightning: Number
    Enable/Disable Lightning

      logo

      public static var logo: String
      The Mirell 3D ASCII logo

        name

        public static var name: String
        Engine name

          textures

          public static var textures: Number
          Enable/Disable Textures

            version

            public static var version: String
            Engine version

              Method Documentation

              render

              public static function render (
              Scene: CScene)
              Renders a frame of the specified scene
              • Parameters:
                Scene
                Initialized and populated scene object
              • Usage:
                C3DEngine.render(myScene);
              • See also:

              setRenderer

              public static function setRenderer (
              Renderer: Function): Void
              Assigns a renderer to use
              Assign a function which will be called when a frame needs to be generated. Mirell 3D provides various performance/quality based renderers in the CRendererFactory class which can be retrieved using CRendererFactory.getRenderer.
              • Parameters:
                Renderer
                Function which handles rendering of a frame
              • Usage:
                C3DEngine.setRenderer( new CRendererFactory().getRenderer(CRendererFactory.MEDIUM) );
              • See also:

              The documentation was generated from the following file: