API Docs for:

BoxGeometry

A BoxGeometry is a parameterized Geometry that defines a box-shaped mesh for attached Meshes.

Overview

  • Dynamically modify a BoxGeometry's dimensions at any time by updating its BoxGeometry/center:property, BoxGeometry/xSize:property, BoxGeometry/ySize:property and BoxGeometry/zSize:property properties.
  • Dynamically switch its primitive type between "points", "lines" and "triangles" at any time by updating its primitive property.

Examples

Usage

An Mesh with a BoxGeometry and a PhongMaterial with diffuse Texture:

new xeogl.Mesh({

    geometry: new xeogl.BoxGeometry({
       center: [0,0,0],
       xSize: 1,  // Half-size on each axis; BoxGeometry is actually two units big on each side.
       ySize: 1,
       zSize: 1
    }),

    material: new xeogl.PhongMaterial({
       diffuseMap: new xeogl.Texture({
           src: "textures/diffuse/uvGrid2.jpg"
       })
    })
});

Constructor

BoxGeometry

(
  • [owner]
  • [cfg]
)

Parameters:

  • [owner] Component optional

    Owner component. When destroyed, the owner will destroy this component as well. Creates this component within 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 BoxGeometry.

    • [primitive="triangles"] String optional

      The primitive type. Accepted values for a BoxGeometry are 'points', 'lines' and 'triangles'.

    • [center] Float32Array optional

      3D point indicating the center position.

    • [xSize=1.0] Number optional

      Half-size on the X-axis.

    • [ySize=1.0] Number optional

      Half-size on the Y-axis.

    • [zSize=1.0] Number optional

      Half-size on the Z-axis.

Methods

create

(
  • [cfg]
)

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

()

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
)

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

hasSubs

(
  • event
)
Boolean

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

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 Component/superTypes:property, 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.

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

off

(
  • subId
)

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

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

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

aabb

Float32Array final

Local-space axis-aligned 3D boundary (AABB) of this geometry.

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

colors

Float32Array

The Geometry's vertex colors.

Default: null

combined

Boolean final

Indicates if this Geometry is combined.

Combination is an internally-performed optimization which combines positions, colors, normals and UVs into the same WebGL vertex buffers with other Geometries, in order to reduce the number of buffer binds performed per frame.

Default: false

destroyed

Boolean

True as soon as this Component has been destroyed

id

String final

Unique ID for this Component within its parent Scene.

indices

Uint16Array | Uint32Array final

The Geometry's indices.

If xeogl.WEBGL_INFO.SUPPORTED_EXTENSIONS["OES_element_index_uint"] is true, then this can be a Uint32Array, otherwise it needs to be a Uint16Array.

Default: null

metadata

Object

Arbitrary, user-defined metadata on this component.

model

Model final

The Model which contains this Component, if any.

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

normals

Float32Array

The Geometry's vertex normals.

Default: null

obb

Float32Array final

Local-space oriented 3D boundary (OBB) of this geometry.

The OBB is represented by a 32-element Float32Array containing the eight vertices of the box, where each vertex is a homogeneous coordinate having [x,y,z,w] elements.

positions

Float32Array

The Geometry's vertex positions.

Default: null

primitive

String

The Geometry's primitive type.

Valid types are: 'points', 'lines', 'line-loop', 'line-strip', 'triangles', 'triangle-strip' and 'triangle-fan'.

Default: "triangles"

quantized

Boolean final

Indicates if this Geometry is quantized.

Compression is an internally-performed optimization which stores positions, colors, normals and UVs in quantized and oct-encoded formats for reduced memory footprint and GPU bus usage.

Quantized geometry may not be updated.

Default: false

scene

Scene final

The parent Scene that contains this Component.

type

String final

JavaScript class name for this Component.

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

uv

Float32Array

The Geometry's UV coordinates.

Default: null

Events

boundary

Fired whenever this Geometry's boundary changes.

Get the latest boundary from the Geometry's aabb and obb properties.

destroyed

Fired when this Component is destroyed.