Skybox
A Skybox is a textured box that does not translate with respect to the Lookat, to a provide the appearance of a background for associated Meshes.
Examples
Usage
In the example below we're going to create twenty randomly-positioned and colored Meshes 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 Meshes
// Share this BoxGeometry among the Meshes
var boxGeometry = new BoxGeometry();
for (var i = 0; i < 20; i++) {
new xeogl.Mesh({
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 Meshes 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.eye = [0, 0, -30];
// Slowly orbit the camera on each frame
scene.on("tick", function () {
scene.camera.orbitYaw(0.2);
});Constructor
Skybox
-
[scene] -
[cfg]
Parameters:
-
[scene]Scene optional -
[cfg]optionalSkybox configuration
-
[id]String optionalOptional ID, unique among all components in the parent Scene, generated automatically when omitted.
-
[meta]String:Object optionalOptional map of user-defined metadata to attach to this Skybox.
-
[src=[null]String optionalPath to skybox texture
-
[encoding="linear"]String optionalTexture encoding format. See the encoding property for more info.
-
[size=1000]Number optionalSize of this Skybox, given as the distance from the center at [0,0,0] to each face.
-
[active=true]Boolean optionalTrue when this Skybox is visible.
-
Index
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]optionalConfiguration 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:
-
messageStringThe 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:
-
eventStringThe event type name
-
valueObjectThe event parameters
-
[forget=false]Boolean optionalWhen true, does not retain for subsequent subscribers
hasSubs
-
event
Returns true if there are any subscribers to the given event on this component.
Parameters:
-
eventStringThe event
Returns:
True if there are any subscribers to the given event on this component.
isType
-
type
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.MeshParameters:
-
typeString | FunctionComponent type to compare with, eg "xeogl.PhongMaterial", or a xeogl component constructor.
Returns:
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>
Parameters:
-
messageStringThe message to log
off
-
subId
Cancels an event subscription that was previously made with Component#on() or Component#once().
Parameters:
-
subIdStringPublication subId
on
-
event -
callback -
[scope=this]
Subscribes to an event on this component.
The callback is be called with this component as scope.
Parameters:
-
eventStringThe event
-
callbackFunctionCalled fired on the event
-
[scope=this]Object optionalScope for the callback
Returns:
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:
-
eventStringData event to listen to
-
callbackFunction(data)Called when fresh data is available at the event
-
[scope=this]Object optionalScope for the callback
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
model
Model
final
The Model which contains this Component, if any.
Will be null if this Component is not in a Model.
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
type
String
final
JavaScript class name for this Component.
For example: "xeogl.AmbientLight", "xeogl.MetallicMaterial" etc.