import {Skybox} from '@xeokit/xeokit-sdk/src/viewer/scene/skybox/Skybox.js'

public class | source

Skybox

Extends:

Component → Skybox

A Skybox.

Constructor Summary

Public Constructor
public	constructor(owner: Component, cfg: *)

Member Summary

Public Members
public set	active(active: Boolean) Sets whether this Skybox is visible or not.
public get	active: Boolean: * Gets if this Skybox is visible or not.
public set	size(value: Number) Sets the size of this Skybox, given as the distance from the center at [0,0,0] to each face.
public get	size: Number: * Gets the size of this Skybox, given as the distance from the center at [0,0,0] to each face.

Inherited Summary

From class Component
public get	owner: Component The Component that owns the lifecycle of this Component, if any.
public	destroyed: Boolean True as soon as this Component has been destroyed
public	id: String \| Number ID of this Component, unique within the Scene.
public	meta: * Arbitrary, user-defined metadata on this component.
public	scene: Scene The parent Scene that contains this Component.
public	viewer: Viewer The viewer that contains this Scene.
public	clear() Destroys all Components that are owned by this.
public	destroy() Destroys this component.
public	error(message: String) Logs an error for this component to the JavaScript console.
public	fire(event: String, value: Object, forget: Boolean) Fires an event on this component.
public	hasSubs(event: String): Boolean Returns true if there are any subscribers to the given event on this component.
public	isType(type: ): : Boolean Tests if this component is of the given type, or is a subclass of the given type.
public	log(message: String) Logs a console debugging message for this component.
public	off(subId: String) Cancels an event subscription that was previously made with Component#on or Component#once.
public	on(event: String, callback: Function, scope: Object): String Subscribes to an event on this component.
public	once(event: String, callback: Function, scope: Object) Subscribes to the next occurrence of the given event, then un-subscribes as soon as the event is subIdd.
public	warn(message: String) Logs a warning for this component to the JavaScript console.

Public Constructors

public constructor(owner: Component, cfg: *) source

Override:

Component#constructor

Params:

Name	Type	Attribute	Description
owner	Component		Owner component. When destroyed, the owner will destroy this PointLight as well.
cfg	*	optional	Skybox configuration
cfg.id	String	optional	Optional ID, unique among all components in the parent {Scene}, generated automatically when omitted.
cfg.src	String	optional default: null	Path to skybox texture
cfg.encoding	String	optional default: "linear"	Texture encoding format. See the Texture#encoding property for more info.
cfg.size	Number	optional default: 1000	Size of this Skybox, given as the distance from the center at `[0,0,0]` to each face.
cfg.active	Boolean	optional default: true	True when this Skybox is visible.

Public Members

public set active(active: Boolean) source

Sets whether this Skybox is visible or not.

Default value is true.

public get active: Boolean: * source

Gets if this Skybox is visible or not.

Default active is true.

Return:

Boolean

true if the Skybox is active.

public set size(value: Number) source

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

Default value is 1000.

public get size: Number: * source

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

Default value is 1000.

Return:

Number

The size.