o3d.ParamDrawContext Class Reference
Inherits
o3d.Param
List of all members.
Detailed Description
A Param which stores a DrawContext.
Public Member Functions
Public Properties
Member Function Documentation
Directly binds two Param elements such that this
parameter gets its value from the source parameter. The
source must be compatible with this parameter.
- Parameters:
-
| sourceParam |
The parameter that the value originates from. Passing in
null will unbind any parameter currently bound. |
- Returns:
-
boolean.True if the bind succeeded.
| boolean ParamDrawContext.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.
| ParamDrawContext.unbindInput |
( |
|
|
) |
[inherited from o3d.Param] |
Breaks any input connection coming into the Param.
Breaks a specific param-bind output connection on this param.
- Parameters:
-
| destinationParam |
param to unbind. |
| ParamDrawContext.unbindOutputs |
( |
|
|
) |
[inherited from o3d.Param] |
Breaks all param-bind output connections on this param.
Member Property Documentation
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.
Unique id of the object.
This id will be unique, even across multiple O3D clients in the same
page.
This property is read-only.
The input connection for this param.
This property is read-only.
The object's name.
Default = "".
This property is read-only.
The output connections for this param.
This property is read-only.
| boolean ParamDrawContext.readOnly
[inherited from o3d.Param]
|
If true the param is read only. Its value can not be set nor can it be used
as the destination in a ParamBind
This property is read-only.
| boolean ParamDrawContext.updateInput
[inherited from o3d.Param]
|
If true, this param will make sure its input param is up to date when
using it as a source. Default = true.
This is for helping with Param cycles.
If paramA gets its value from paramB and paramB gets its value from
paramA:\n
If you go paramA.value, paramB will evaluate then copy to paramA.\n
If you go paramB.value, paramA will evaluate then copy to paramB.\n
If you set paramB.updateInput = false, then:\n
If you go paramA.value, paramB will evaluate then copy to paramA.\n
If you go paramB.value, paramB just copy paramA. paramA will NOT evaluate
when paramB asks for its value.
The DrawContext stored by the Param.
|
