API Docs for: 1.0.0

Skybox

Extends Component
Module: skyboxes
Parent Module: xeogl

A Skybox is a textured box that does not translate with respect to the viewing transform, to a provide the appearance of a background for associated Entities.

Examples

Usage

In the example below we're going to create twenty randomly-positioned and colored Entities and wrap them in a Skybox. The Skybox will use the texture image shown below, and the result will appear like the screen capture shown above.

// A bunch of random cube Entities

// Share this BoxGeometry among the Entities
var boxGeometry = new BoxGeometry();

for (var i = 0; i < 20; i++) {
       new xeogl.Entity({
           geometry: boxGeometry,
           transform: new xeogl.Translate({
               xyz: [
                   Math.random() * 15 - 7,
                   Math.random() * 15 - 7,
                   Math.random() * 15 - 7
               ]
           }),
           material: new xeogl.PhongMaterial({
               diffuse: [
                   Math.random(),
                   Math.random(),
                   Math.random()
               ]
           })
       });
   }

// A Skybox that wraps our Entities in a cloudy background
var skybox = new xeogl.Skybox({
       src: "textures/skybox/miramarClouds.jpg",
       size: 1000 // Default
   });

// Get the default Scene off the Skybox
var scene = skybox.scene;

// Move the camera back a bit
scene.camera.view.eye = [0, 0, -30];

// Slowly orbit the camera on each frame
scene.on("tick", function () {
        scene.camera.view.rotateEyeY(0.2);
    });

Constructor

Skybox

(
  • [scene]
  • [cfg]
)

Parameters:

  • [scene] Scene optional

    Parent Scene, creates this Skybox within the default Scene when omitted

  • [cfg] optional

    Skybox configuration

    • [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 Skybox.

    • [src=[null]] String optional

      Path to skybox texture

    • [size=1000] Size of this Skybox, given as the distance from the center at [0,0,0] Number optional

      to each face.

    • [active=true] Boolean optional

      True when this Skybox is visible.

Methods

build

(
  • geometry
)

Loads all the voxels accumulated from previous calls to VoxelGeometryBuilder/writeVoxel:method into a target Geometry.

Retains all that state afterwards, so that you can continue to call this method to add the state to other Geometries.

Parameters:

Returns:

this

clearVoxel

(
  • pos
)

Clears a voxel.

Ignored if the voxel is already clear, or if the given position falls outside this VoxelGeometryBuilder's voxel space extents.

It's OK to just blindly clear voxels that are already clear, there is little performance penalty.

Parameters:

  • pos Float32Array

    3D Voxel position.

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

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

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.

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

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

reset

()

Resets this VoxelGeometryBuilder, clearing all the state previously accumulated with VoxelGeometryBuilder/setVoxel:method and VoxelGeometryBuilder/setShape:method.

Returns:

this

setShape

(
  • shape
)

Sets the shape that the VoxelGeometryBuilder/build:method will add to target Geometries for each voxel.

The shape can be either a Geometry or a JavaScript object containing vertex and index arrays.

Parameters:

Returns:

this

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

writeVoxel

(
  • pos
)

Writes a voxel.

Ignored if the voxel is already written, or if the given position falls outside this VoxelGeometryBuilder's voxel space extents.

It's OK to just blindly write voxels that have already been written, there is little performance penalty.

Parameters:

  • pos Float32Array

    3D Voxel position.

Properties

active

Boolean

Indicates whether this Skybox is visible or not.

Fires a active event on change.

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.

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.

scene

Scene final

The parent Scene that contains this Component.

size

Number

Size of this Skybox, given as the distance from the center at [0,0,0] to each face.

Fires an size event on change.

Default: 1000

string

String final

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

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.

type

String final

JavaScript class name for this Component.

This is used when loading Scenes from JSON, and is included in the JSON representation of this Component, so that this class may be instantiated when loading it from the JSON representation.

For example: "xeogl.AmbientLight", "xeogl.ColorTarget", "xeogl.Lights" etc.

Events

active

Fired whenever this Skybox's active property changes.

Event Payload:

  • value Boolean

    The property's new value

destroyed

Fired when this Component is destroyed.

size

Fired whenever this Skybox's size property changes.

Event Payload:

  • value Array of Number

    The property's new value