xeogl / API Docs

API Docs for:

XML3DModel

Extends Model
Defined in: /home/lindsay/xeolabs/xeogl-next/xeogl/examples/js/models/XML3DModel.js:1
Module: models
Parent Module: xeogl

A XML3DModel is a Model loaded from a 3DXML file.

Constructor

XML3DModel

(
  • [scene]
  • [cfg]
)

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/examples/js/models/XML3DModel.js:1

Parameters:

  • [scene] Scene optional

    Parent Scene - creates this XML3DModel 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 XML3D.

    • [src] String optional

      Path to a 3DXML file. You can set this to a new file path at any time.

    • [displayEffect] String optional

      Display effect to render with: "shadedWithEdges" | "shaded" | "hiddenLinesRemoved" | "hiddenLinesVisible" | "wireframe".

Methods

angleVec3

(
  • v
  • w
)
Number

Inherited from Model: /home/lindsay/xeolabs/xeogl-next/xeogl/src/math/math.js:793

Gets the angle between two vectors

Parameters:

  • v Object
  • w Object

Returns:

Number:

clear

()

Inherited from Model: /home/lindsay/xeolabs/xeogl-next/xeogl/src/models/model.js:256

Destroys all Components in this Model.

create

(
  • [cfg]
)

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:919

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

The method is given a component configuration, like so:

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

Parameters:

  • [cfg] optional

    Configuration for the component instance.

Returns:

:

destroy

()

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:1028

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

error

(
  • message
)

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:606

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]
)

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:430

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

hasSubs

(
  • event
)
Boolean

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:557

Returns true if there are any subscribers to the given event on this component.

Parameters:

  • event String

    The event

Returns:

Boolean:

True if there are any subscribers to the given event on this component.

isType

(
  • type
)
Boolean

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:394

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.Mesh); // Returns false, because xeogl.Rotate does not (even indirectly) extend xeogl.Mesh

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.

load

(
  • model
  • src
  • options
  • [ok]
  • [error]
)
static

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/examples/js/models/XML3DModel.js:216

Loads 3DXML from a URL into a Model.

Parameters:

  • model Model

    Model to load into.

  • src String

    Path to 3DXML file.

  • options Object

    Loading options.

  • [ok] Function optional

    Completion callback.

  • [error] Function optional

    Error callback.

log

(
  • message
)

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:568

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

lookAtMat4v

(
  • pos
  • target
  • up
  • dest
)
Mat4

Inherited from Model: /home/lindsay/xeolabs/xeogl-next/xeogl/src/math/math.js:2035

Returns a 4x4 'lookat' viewing transform matrix.

Parameters:

  • pos Object

    vec3 position of the viewer

  • target Object

    vec3 point the viewer is looking at

  • up Object

    vec3 pointing "up"

  • dest Object

    mat4 Optional, mat4 matrix will be written into

Returns:

Mat4:

dest if specified, a new mat4 otherwise

off

(
  • subId
)

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:511

Cancels an event subscription that was previously made with Component#on() or Component#once().

Parameters:

  • subId String

    Publication subId

on

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

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:469

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]
)

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:536

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

This is equivalent to calling Component#on(), and then calling Component#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

removeChild

(
  • object
)

Inherited from Object: /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:886

Removes the given child.

Parameters:

  • object Object

    Child to remove.

removeChildren

()

Inherited from Object: /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:908

Removes all children.

rotate

(
  • angle
)

Inherited from Object but overwritten in /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:928

Rotates about the given local axis by the given increment.

Parameters:

  • angle Number

    Angle increment in degrees.

rotateX

(
  • angle
)

Inherited from Object: /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:967

Rotates about the local X-axis by the given increment.

Parameters:

  • angle Number

    Angle increment in degrees.

rotateY

(
  • angle
)

Inherited from Object: /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:977

Rotates about the local Y-axis by the given increment.

Parameters:

  • angle Number

    Angle increment in degrees.

rotateZ

(
  • angle
)

Inherited from Object: /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:987

Rotates about the local Z-axis by the given increment.

Parameters:

  • angle Number

    Angle increment in degrees.

scaleMat4c

(
  • x
  • y
  • z
  • m
)

Inherited from Model but overwritten in /home/lindsay/xeolabs/xeogl-next/xeogl/src/math/math.js:1747

Efficiently post-concatenates a scaling to the given matrix.

Parameters:

  • x Object
  • y Object
  • z Object
  • m Object

translate

(
  • axis
  • distance
)

Inherited from Object: /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:997

Translates along local space vector by the given increment.

Parameters:

  • axis Float32Array

    Normalized local space 3D vector along which to translate.

  • distance Number

    Distance to translate along the vector.

translateX

(
  • distance
)

Inherited from Object but overwritten in /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:1014

Translates along the local X-axis by the given increment.

Parameters:

  • distance Number

    Distance to translate along the X-axis.

warn

(
  • message
)

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:589

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

aabb

Float32Array final

Inherited from Object: /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:1352

World-space 3D axis-aligned bounding box (AABB).

Represented by a six-element Float32Array containing the min/max extents of the axis-aligned volume, ie. [xmin, ymin,zmin,xmax,ymax, zmax].

aabbVisible

Boolean

Inherited from Object: /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:1707

Indicates if the 3D World-space axis-aligned bounding box (AABB) is visible.

Default: false

castShadow

Boolean

Inherited from Object: /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:1669

Indicates if casting shadows.

Default: true

center

Float32Array final

Inherited from Object: /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:1369

World-space 3D center.

childIDs

Array final

Inherited from Object: /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:1110

IDs of child Object.

childMap

final

Inherited from Object: /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:1099

Child Object mapped to their IDs.

children

Array final

Inherited from Object: /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:1088

Array of child Object.

clippable

Boolean

Inherited from Object: /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:1531

Indicates if clippable.

Clipping is done by the Scene's Clips component.

Default: true

collidable

Boolean

Inherited from Object: /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:1552

Indicates if included in boundary calculations.

Default: true

colorize

Float32Array

Inherited from Object: /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:1592

RGB colorize color, multiplies by the rendered fragment color.

Default: [1.0, 1.0, 1.0]

components

String:Component

Inherited from Model: /home/lindsay/xeolabs/xeogl-next/xeogl/src/models/model.js:70

All contained Components, mapped to their IDs.

culled

Boolean

Inherited from Object: /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:1509

Indicates if culled from view.

Only rendered when visible is true and culled is false.

Default: false

DEGTORAD

Number

Inherited from Model: /home/lindsay/xeolabs/xeogl-next/xeogl/src/math/math.js:16

The number of radiians in a degree (0.0174532925).

destroyed

Boolean

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:318

True as soon as this Component has been destroyed

displayEffect

String

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/examples/js/models/XML3DModel.js:115

Display effect to render with: "shadedWithEdges" | "shaded" | "hiddenLinesRemoved" | "hiddenLinesVisible" | "wireframe".

Default: "shadedWithEdges"

edges

Boolean

Inherited from Object: /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:1490

Indicates if edges are emphasized.

Default: false

entities

String:Object final

Inherited from Model: /home/lindsay/xeolabs/xeogl-next/xeogl/src/models/model.js:138

Object in this Model that have entity types, mapped to their IDs.

Each Object is registered in this map when its entityType is set to value.

entityIds

Array of String final

Inherited from Model: /home/lindsay/xeolabs/xeogl-next/xeogl/src/models/model.js:307

Convenience array of IDs in entities.

entityType

String final

Inherited from Object: /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:1059

Optional entity classification when using within a semantic data model.

See the Object documentation on "Applying a semantic data model" for usage.

Default: null

entityTypeIds

Array of String final

Inherited from Model but overwritten in /home/lindsay/xeolabs/xeogl-next/xeogl/src/models/model.js:281

Convenience array of entity type IDs in entityTypes.

entityTypes

String:{String:xeogl.Component} final

Inherited from Model: /home/lindsay/xeolabs/xeogl-next/xeogl/src/models/model.js:150

For each entity type, a map of IDs to Object of that entity type.

Each Object is registered in this map when its entityType is assigned a value.

ghosted

Boolean

Inherited from Object: /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:1438

Indicates if ghosted.

Each ghosted Object is registered in its Scene's ghostedEntities map while its entityType is set to a value.

Default: false

guid

String final

Inherited from Object: /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:1044

Globally unique identifier.

This is unique not only within the Scene, but throughout the entire universe.

Only defined when given to the constructor.

guidObjects

String:Object final

Inherited from Model: /home/lindsay/xeolabs/xeogl-next/xeogl/src/models/model.js:117

Object in this Model that have GUIDs, mapped to their GUIDs.

Each Object is registered in this map when its guid is assigned a value.

highlighted

Boolean

Inherited from Object: /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:1412

Indicates if highlighted.

Each highlighted Object is registered in its Scene's highlightedEntities map while its entityType is set to a value.

Default: false

id

String final

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:309

Unique ID for this Component within its parent Scene.

matrix

Float32Array

Inherited from Object: /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:1235

Local matrix.

Default: [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]

meshes

String:xeogl.Mesh final

Inherited from Model: /home/lindsay/xeolabs/xeogl-next/xeogl/src/models/model.js:129

All contained Meshes, mapped to their IDs.

metadata

Object

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:301

Arbitrary, user-defined metadata on this component.

model

Model final

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:381

The Model which contains this Component, if any.

Will be null if this Component is not in a Model.

numChildren

Number final

Inherited from Object: /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:1077

Number of child Object.

numComponents

Number

Inherited from Model: /home/lindsay/xeolabs/xeogl-next/xeogl/src/models/model.js:78

Number of contained Components.

objects

String:Object final

Inherited from Model: /home/lindsay/xeolabs/xeogl-next/xeogl/src/models/model.js:108

All contained Object, mapped to their IDs.

opacity

Number

Inherited from Object: /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:1623

Opacity factor, multiplies by the rendered fragment alpha.

This is a factor in range [0..1].

Default: 1.0

outlined

Boolean

Inherited from Object: /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:1650

Indicates if outlined.

Default: false

parent

Group

Inherited from Object: /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:1124

The parent.

The parent Group may also be set by passing the Object to the Group/Model's Group/addChild:method method.

pickable

Boolean

Inherited from Object: /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:1571

Whether or not to allow picking.

Picking is done via calls to Scene#pick().

Default: true

position

Float32Array

Inherited from Object: /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:1161

Local translation.

Default: [0,0,0]

quaternion

Float32Array

Inherited from Object: /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:1198

Local rotation quaternion.

Default: [0,0,0, 1]

RADTODEG

Number

Inherited from Model: /home/lindsay/xeolabs/xeogl-next/xeogl/src/math/math.js:23

The number of degrees in a radian.

receiveShadow

Boolean

Inherited from Object: /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:1688

Indicates if receiving shadows.

Default: true

rotation

Float32Array

Inherited from Object: /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:1179

Local rotation, as Euler angles given in degrees, for each of the X, Y and Z axis.

Default: [0,0,0]

scale

Float32Array

Inherited from Object: /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:1217

Local scale.

Default: [1,1,1]

scene

Scene final

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:253

The parent Scene that contains this Component.

selected

Boolean

Inherited from Object: /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:1464

Indicates if selected.

Each selected Object is registered in its Scene's selectedEntities map while its entityType is set to a value.

Default: false

src

String

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/examples/js/models/XML3DModel.js:76

Path to a 3DXML file.

You can set this to a new file path at any time (except while loading), which will cause the XML3D to load components from the new file (after first destroying any components loaded from a previous file path).

Fires a XML3D/loaded:event event when the 3DXML has loaded.

superTypes

Array of String final

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:352

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.

supportedSchemas

String

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/examples/js/models/XML3DModel.js:29

Supported 3DXML schema versions

type

String final

Inherited from Component but overwritten in /home/lindsay/xeolabs/xeogl-next/xeogl/src/models/model.js:55

JavaScript class name for this Component.

For example: "xeogl.AmbientLight", "xeogl.MetallicMaterial" etc.

types

String:{String:xeogl.Component}

Inherited from Model: /home/lindsay/xeolabs/xeogl-next/xeogl/src/models/model.js:86

A map of maps; for each contained Component type, 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>,
     },
//...

viewpoint

Float32Array

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/examples/js/models/XML3DModel.js:62

Default viewpoint, containing eye, look and up vectors. Only defined if found in the 3DXML file.

visible

Boolean

Inherited from Object: /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:1383

Indicates if visible.

Only rendered when visible is true and culled is false.

Each visible Object is registered in its Scene's visibleEntities map while its entityType is set to a value.

Default: true

worldMatrix

Float32Array

Inherited from Object: /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:1266

The World matrix.

worldNormalMatrix

Float32Array

Inherited from Object: /home/lindsay/xeolabs/xeogl-next/xeogl/src/objects/object.js:1279

This World normal matrix.

Default: [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]

Events

destroyed

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:1096

Fired when this Component is destroyed.

error

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/examples/js/models/XML3DModel.js:248

Fired whenever this XML3D fails to load the 3DXML file specified by XML3D/src:property.

Event Payload:

  • msg String

    Description of the error

loaded

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/examples/js/models/XML3DModel.js:98

Fired whenever this XML3D has finished loading components from the 3DXML file specified by XML3D/src:property.