My favorites | English | Sign in

o3d.DrawList Class Reference

Inherits o3d.NamedObject

List of all members.


Detailed Description

A DrawList gets used during rendering to collect DrawElements to render. Each Material references a DrawList. Depending on the material, as DrawElements get collected they will be put on different DrawLists.

Public Types

enum SortMethod o3d.DrawList

Public Member Functions

boolean  isAClassName(className) o3d.ObjectBase

Public Properties

string className o3d.ObjectBase
number clientId o3d.ObjectBase
string name o3d.NamedObject

Public Types Documentation

enum o3d.DrawList.SortMethod

SortMethod,

  • BY_PERFORMANCE
  • BY_Z_ORDER
  • BY_PRIORITY Method to sort DrawList by.

  • Member Function Documentation

    boolean DrawList.isAClassName ( string className ) [inherited from o3d.ObjectBase]

    Takes the name of a class as an argument, and returns true if this object is either an instance of that class or derives from that class.

    var t = pack.createObject('o3d.Transform');
    t.isAClassName('o3d.Transform');    // true
    t.isAClassName('o3d.ParamObject');  // true
    t.isAClassName('o3d.Shape');        // false
    
    Parameters:
    className Name of class to check for.
    Returns:
    boolean.true if this object is a or is derived from the given class name.

    Member Property Documentation

    string DrawList.className [inherited from o3d.ObjectBase]

    The concrete class name for an object derived from ObjectBase. If you want to know if an object is of a certain type you should use objectBase.isAClassName

    var t = pack.createObject('o3d.Transform');
    t.className == 'o3d.Transform';  // true
    
    This property is read-only.
    number DrawList.clientId [inherited from o3d.ObjectBase]

    Unique id of the object. This id will be unique, even across multiple O3D clients in the same page. This property is read-only.

    string DrawList.name [inherited from o3d.NamedObject]

    The object's name. Setting this has no meaning to O3D, but is useful for debugging and for the functions Client.getObjects, Pack.getObject, RenderNode.getRenderNodesByNameInTree and RenderNode.getTransformsByNameInTree which search for objects by name.