API Docs for: 1.0.0

BuildableModel

Extends Model
Module: models
Parent Module: xeogl

A BuildableModel is a Model that provides a "stateful builder" API through which you can procedurally generate xeogl content.

Overview

  • A BuilderModel implements the Builder pattern.
  • Create various assets within a BuilderModel, such as Geometries and Materials, then create Entities that use those assets.
  • The BuilderModel then owns those components and will destroy them when you call its clear() or destroy() methods.
  • A BuildableModel can be transformed within World space by attaching it to a Transform.
  • A BuildableModel provides its World-space boundary as a Boundary3D.

Examples

Usage

A BuildableModel containing ten textured boxes with random sizes and positions:

var model = new xeogl.BuildableModel();

// Add a BoxGeometry asset
buildableModel.asset("boxGeometry", {
    type: "xeogl.BoxGeometry"
});

// Add a PhongMaterial asset
buildableModel.asset("gridMaterial", {
    type: "xeogl.PhongMaterial",
    ambient: [0.9, 0.3, 0.9],
    shininess: 30,
    diffuseMap: {
        src: "textures/diffuse/gridMaterial.jpg"
    }
});

// Set the BoxGeometry asset as the current geometry
buildableModel.geometry("boxGeometry");

// Set the PhongMaterial asset as the current material
buildableModel.material("gridMaterial");

// Build ten entities with random sizes and positions,
// that each get the current geometry and material
for (var i = 0; i < 10; i++) {

    buildableModel.scale(Math.random() * 10 + 1, Math.random() * 10 + 1, Math.random() * 10 + 1);
    buildableModel.pos(Math.random() * 100 - 50, Math.random() * 100 - 50, Math.random() * 100 - 50);

    buildableModel.entity();
}

Constructor

BuildableModel

(
  • [scene]
  • [cfg]
)

Parameters:

  • [scene] Scene optional

    Parent Scene - creates this BuildableModel in the default Scene when omitted.

  • [cfg] optional

    Configs

    • [id] String optional

      Optional ID, unique among all components in the parent Scene, generated automatically when omitted.

    • [meta] String:Object optional

      Optional map of user-defined metadata to attach to this BuildableModel.

    • [transform] Number | String | Transform optional

      A Local-to-World-space (modelling) Transform to attach to this BuildableModel. Must be within the same Scene as this BuildableModel. Internally, the given Transform will be inserted above each top-most Transform that the BuildableModel attaches to its Entities.

Methods

add

(
  • component
)

Inherited from Model: src/models/model.js:330

Adds a Component or subtype to this Model.

The Component(s) may be specified by ID, instance, JSON definition or type.

See class comment for usage examples.

The Components must be in the same Scene as this Model.

Fires an added event.

Parameters:

  • component Number | String | | Component

    ID, definition or instance of a Component type or subtype.

angles

(
  • x
  • y
  • z
)

Sets the 3D Euler rotation angles for each Entity subsequently created with entity().

Parameters:

  • x Number

    Angle on X-axis in degrees.

  • y Number

    Angle on Y-axis in degrees.

  • z Number

    Angle on Z-axis in degrees.

asset

(
  • assetId
  • cfg
)

Adds an asset to this BuildableModel.

The asset is given as a configuration object, to be lazy-instantiated as soon as an entity is built from it with entity().

Usage

Adding a PhongMaterial asset with ID "gridMaterial":

buildableModel.asset("gridMaterial", {
    type: "xeogl.PhongMaterial",
    ambient: [0.9, 0.3, 0.9],
    shininess: 30,
    diffuseMap: {
        src: "textures/diffuse/uvGrid2.jpg"
    }
});

Adding a BoxGeometry asset with ID "boxGeometry":

buildableModel.asset("boxGeometry", {
    type: "xeogl.BoxGeometry",
    xSize: 1.0,
    ySize: 1.0,
    zSize: 1.0
});

Parameters:

  • assetId String | Number

    A unique ID for the asset.

  • cfg

    Configuration object for the asset.

axis

(
  • a
  • b
  • c
)

Sets the order of 3D rotations for each Entity subsequently created with entity().

Usage

The X, Y and Z axis are identified as 0, 1, 2 respectively.

buildableModel.axis(0,1,2); // X, Y, Z
buildableModel.axis(2,0,1); // Z, X, Y
buildableModel.axis(1,2,0); // Y, Z, X

Parameters:

  • a Number

    Indicates the first rotation axis.

  • b Number

    Indicates the second rotation axis.

  • c Number

    Indicates the third rotation axis.

clear

()

Removes all assets and Entities from this BuildableModel.

create

(
  • [cfg]
  • [instanceId]
)

Convenience method for creating a Component within this Component's Scene.

You would typically use this method to conveniently instantiate components that you'd want to share (ie. "instance") among your Entities.

The method is given a component type, configuration and optional instance ID, like so:

var material = myComponent.create(xeogl.PhongMaterial, {
     diffuse: [1,0,0],
     specular: [1,1,0]
}, "myMaterial");

The first time you call this method for the given type and instanceId, this method will create the PhongMaterial, passing the given attributes to the component's constructor.

If you call this method again, specifying the same type and instanceId, the method will return the same component instance that it returned the first time, and will ignore the configuration:

var material2 = component.create(xeogl.PhongMaterial, { specular: [1,1,0] }, "myMaterial");

So in this example, our PhongMaterial will continue to have the red specular and diffuse color that we specified the first time.

Each time you call this method with the same type and instanceId, the Scene will internally increment a reference count for the component instance. You can release the shared component instance with a call to Scene/putSharedComponent:method, and once you have released it as many times as you got it, the Scene will destroy the component.

Parameters:

  • [cfg] optional

    Configuration for the component instance - only used if this is the first time you are getting the component, ignored when reusing an existing instance.

  • [instanceId] String | Number optional

    Identifies the shared component instance. Note that this is not used as the ID of the component - you can specify the component ID in the cfg parameter.

Returns:

:

destroy

()

Destroys this component.

Fires a destroyed event on this Component.

Automatically disassociates this component from other components, causing them to fall back on any defaults that this component overrode on them.

TODO: describe effect with respect to #create

destroyAll

()

Inherited from Model: src/models/model.js:519

Destroys all Components in this Model.

entity

(
  • [id]
)

Creates an Entity with whatever assets and states are currently set on this BuildableModel.

Parameters:

  • [id] String | Number optional

    A unique ID for the new Entity.

error

(
  • message
)

Logs an error for this component to the JavaScript console.

The console message will have this format: [ERROR] [<component type> =<component id>: <message>

Also fires the message as an error event on the parent Scene.

Parameters:

  • message String

    The message to log

fire

(
  • event
  • value
  • [forget=false]
)

Fires an event on this component.

Notifies existing subscribers to the event, optionally retains the event to give to any subsequent notifications on the event as they are made.

Parameters:

  • event String

    The event type name

  • value Object

    The event parameters

  • [forget=false] Boolean optional

    When true, does not retain for subsequent subscribers

geometry

(
  • assetId
)

Selects the Geometry asset that will be added to each Entity subsequently created with entity().

The given ID must belong to a Geometry asset that was added previously with asset().

Parameters:

  • assetId String | Number

    The asset ID.

isType

(
  • type
)
Boolean

Tests if this component is of the given type, or is a subclass of the given type.

The type may be given as either a string or a component constructor.

This method works by walking up the inheritance type chain, which this component provides in property superTypes, returning true as soon as one of the type strings in the chain matches the given type, of false if none match.

Examples:

var myRotate = new xeogl.Rotate({ ... });

myRotate.isType(xeogl.Component); // Returns true for all xeogl components
myRotate.isType("xeogl.Component"); // Returns true for all xeogl components
myRotate.isType(xeogl.Rotate); // Returns true
myRotate.isType(xeogl.Transform); // Returns true
myRotate.isType("xeogl.Transform"); // Returns true
myRotate.isType(xeogl.Entity); // Returns false, because xeogl.Rotate does not (even indirectly) extend xeogl.Entity

Parameters:

  • type String | Function

    Component type to compare with, eg "xeogl.PhongMaterial", or a xeogl component constructor.

Returns:

Boolean:

True if this component is of given type or is subclass of the given type.

iterate

(
  • callback
  • [scope=this]
)

Inherited from Model: src/models/model.js:618

Iterates with a callback over the Components in this Model.

Parameters:

  • callback Function

    Callback called for each Component.

  • [scope=this] Object optional

    Optional scope for the callback, defaults to this Model.

log

(
  • message
)

Logs a console debugging message for this component.

The console message will have this format: [LOG] [<component type> <component id>: <message>

Also fires the message as a log event on the parent Scene.

Parameters:

  • message String

    The message to log

material

(
  • assetId
)

Selects the Material asset that will be added to each Entity subsequently created with entity().

The given ID must belong to a Material asset that was added previously with asset().

Parameters:

  • assetId String | Number

    The asset ID.

off

(
  • handle
)

Cancels an event subscription that was previously made with on or once.

Parameters:

  • handle String

    Publication handle

on

(
  • event
  • callback
  • [scope=this]
)
String

Subscribes to an event on this component.

The callback is be called with this component as scope.

Parameters:

  • event String

    The event

  • callback Function

    Called fired on the event

  • [scope=this] Object optional

    Scope for the callback

Returns:

String:

Handle to the subscription, which may be used to unsubscribe with {@link #off}.

once

(
  • event
  • callback
  • [scope=this]
)

Subscribes to the next occurrence of the given event, then un-subscribes as soon as the event is handled.

This is equivalent to calling on, and then calling off inside the callback function.

Parameters:

  • event String

    Data event to listen to

  • callback Function(data)

    Called when fresh data is available at the event

  • [scope=this] Object optional

    Scope for the callback

pos

(
  • x
  • y
  • z
)

Sets the 3D position of each Entity subsequently created with entity().

Parameters:

  • x Number

    Position on X-axis.

  • y Number

    Position on Y-axis.

  • z Number

    Position on Z-axis.

removeAll

()

Inherited from Model: src/models/model.js:555

Removes all Components from this Model.

reset

()

Resets the state of this BuildableModel to defaults.

scale

(
  • x
  • y
  • z
)

Sets the 3D scale of each Entity subsequently created with entity().

Parameters:

  • x Number

    Scale on X-axis.

  • y Number

    Scale on Y-axis.

  • z Number

    Scale on Z-axis.

warn

(
  • message
)

Logs a warning for this component to the JavaScript console.

The console message will have this format: [WARN] [<component type> =<component id>: <message>

Also fires the message as a warn event on the parent Scene.

Parameters:

  • message String

    The message to log

Properties

components

String:Component

Inherited from Model: src/models/model.js:258

The Components within this Model, mapped to their IDs.

Fires an Model/updated:event event on change.

destroyed

Boolean

True as soon as this Component has been destroyed

entities

String:Entity

Inherited from Model: src/models/model.js:298

The Entity component instances within this Model, mapped to their IDs.

id

String final

Unique ID for this Component within its parent Scene.

isDefault

Boolean

Indicates whether this is one of the Scene's built-in Components.

json

JSON final

JSON object containing the state of this Component.

metadata

Object

Arbitrary, user-defined metadata on this component.

numComponents

Number

Inherited from Model: src/models/model.js:268

The number of Components within this Model.

scene

Scene final

The parent Scene that contains this Component.

string

String final

Inherited from Component but overwritten in src/component.js:1058

String containing the serialized JSON state of this Component.

superTypes

Array of String final

An array of strings that indicates the chain of super-types within this component's inheritance hierarchy.

For example, if this component is a Rotate, which extends Transform, which in turn extends Component, then this property will have the value:

["xeogl.Component", "xeogl.Transform"]
                    

Note that the chain is ordered downwards in the hierarchy, ie. from super-class down towards sub-class.

transform

Transform

Inherited from Model: src/models/model.js:637

The Local-to-World-space (modelling) Transform attached to this Model.

Must be within the same Scene as this Model.

Internally, the given Transform will be inserted above each top-most Transform that the Model attaches to its Entities.

Fires an transform event on change.

type

String final

Inherited from Component but overwritten in src/models/model.js:247

JavaScript class name for this Component.

types

String:{String:xeogl.Component}

Inherited from Model: src/models/model.js:276

A map of maps; for each Component type in this Model, a map to IDs to Component instances, eg.

"xeogl.Geometry": {
                      "alpha": <xeogl.Geometry>,
                      "beta": <xeogl.Geometry>
                    },
                    "xeogl.Rotate": {
                      "charlie": <xeogl.Rotate>,
                      "delta": <xeogl.Rotate>,
                      "echo": <xeogl.Rotate>,
                    },
                    //...
                    

worldBoundary

Boundary3D final

Inherited from Model: src/models/model.js:678

World-space 3D boundary enclosing all the components in this Model.

If you call destroy on this boundary, then this property will be assigned to a fresh Boundary3D instance next time you reference it.

Events

added

Inherited from Model: src/models/model.js:478

Fired whenever an individual Component is added to this Model.

Event Payload:

destroyed

Fired when this Component is destroyed.

removed

Inherited from Model: src/models/model.js:606

Fired whenever an individual Component is removed from this Model.

Event Payload:

transform

Inherited from Model: src/models/model.js:655

Fired whenever this Model's transform property changes.

Event Payload:

  • value Object

    The property's new value