Conainer interface. This declares members for Container Components. see Container for more details.
The main instance that manages this component
current options of the component
The parent component that manages this component
Name of the component.
A string tag that categorizes the component. e.g. trans, render
Default options for this component
Map from option name to handler methods. The handler methods are called in order when on an option is updated with a Model.set call. This allows component to respond to option changes live. e.g. In a Live-Edit User Interface for preset development.
Destroys and cleansup resources. Please override to cleanup component specific resources.
Performs drawing operations. Override to implement drawing for this component. Typically you'd make some WebGL operations to render to the framebuffer manager of this components parent.
Calls each of the listeners registered for a given event.
Return an array listing the events for which the emitter has registered listeners.
returns a component options given name
Returns the id of this component
Returns the last error. That raised an
/ path to the component from the root.
Initializes the component. Override this method to add initialization for the component. Typically you'd call some updateHandlers here to initialize states from the component options.
Returns whether this component is enabled or not
Add a listener to another EventEmitter.
This provides an event subscription list facility. Allowing subclasses to listen to other emitters and remove all or some listeners with a single call to Model.stopListening, later.
the event emitter to listen to
the name of the event to listen to
the callback for the event handler
Return the number of listeners listening to a given event.
Return the listeners registered for a given event.
Add a listener for a given event.
Add a one-time listener for a given event.
Remove all listeners, or those of the specified event.
Remove the listeners of a given event.
Safely set an attribute(s).
If the attribute set succeeds, a
change:[attribute name] event is fired.
change:[attribute name] event handler receives
this object, the new
options as arguments.
change event is also fired when all changes succeed. The
this object and the
options as arguments.
the name of the attribute or map of values
the new value of the attribute
this object is sent down to the event handlers, useful to things down to your
options.silent is true then events are not fired.
Sets the parent of this component
the new parent of this component
Removes to one or more listeners that were set earlier with calls to Model.listenTo.
Use the arguments to filter subscriptions. eg:
model.stopListening(em) will remove all
listeners on emitter
model.stopListening(em, 'change') will remove all listeners for
change event on emitter
the event emitter on which the listener was set
the event to be removed
the callback to be removed
Returns the JSON representation of the component options.
This value if passed into constructor will instantiate a component that behaves the same as this component.
Returns the name of the component
Returns a string tag that categorizes the component. e.g. trans, render