My favorites | English | Sign in

o3d.Function Class Reference

Inherits o3d.NamedObject

List of all members.


Detailed Description

A Function is a class that has an Evaluate method. Evaluate takes 1 input and returns 1 output.

Public Member Functions

number  evaluate(input) o3d.Function
boolean  isAClassName(className) o3d.ObjectBase

Public Properties

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

Member Function Documentation

number Function.evaluate ( number input )

Gets an output for this function for the given input.

Parameters:
input Input to get output at.
Returns:
number.The output for the given input.
boolean Function.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 Function.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 Function.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 Function.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.