API Docs for: 1.0.0

Texture

Extends Component
Module: materials
Parent Module: xeogl

A Texture specifies a texture map.

Overview

  • Textures are grouped within Materials, which are attached to Entities.
  • To create a Texture from an image file, set the Texture's src property to the image file path.
  • To create a Texture from an HTMLImageElement, set the Texture's image property to the HTMLImageElement.

Examples

Usage

In this example we have an Entity with

Note that xeogl will ignore the PhongMaterial's diffuse and specular properties, since we assigned Textures to the PhongMaterial's diffuseMap and specularMap properties. The Textures' pixel colors directly provide the diffuse and specular components for each fragment across the Geometry surface.

var entity = new xeogl.Entity({

   lights: new xeogl.Lights({
       lights: [
           new xeogl.AmbientLight({
               color: [0.7, 0.7, 0.7]
           }),
           new xeogl.DirLight({
               dir: [-1, -1, -1],
               color: [0.5, 0.7, 0.5],
               intensity: [1.0, 1.0, 1.0],
               space: "view"
           })
       ]
   }),

   material: new xeogl.PhongMaterial({
       ambient: [0.3, 0.3, 0.3],
       diffuse: [0.5, 0.5, 0.0],   // Ignored, since we have assigned a Texture to diffuseMap, below
       specular: [1.0, 1.0, 1.0],   // Ignored, since we have assigned a Texture to specularMap, below
       diffuseMap: new xeogl.Texture({
           src: "diffuseMap.jpg"
       }),
       specularMap: new xeogl.Fresnel({
           src: "diffuseMap.jpg"
       }),
       shininess: 80, // Default
       alpha: 1.0 // Default
   }),

   geometry: new xeogl.TorusGeometry()
});

Constructor

Texture

(
  • [scene]
  • [cfg]
)

Parameters:

  • [scene] Scene optional

    Parent Scene - creates this Texture in the default Scene when omitted.

  • [cfg] optional

    Configs

    • [id] String optional

      Optional ID for this Texture, 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 Texture.

    • [src=null] String optional

      Path to image file to load into this Texture. See the src property for more info.

    • [image=null] HTMLImageElement optional

      HTML Image object to load into this Texture. See the image property for more info.

    • [minFilter="linearMipmapLinear"] String optional

      How the texture is sampled when a texel covers less than one pixel. See the minFilter property for more info.

    • [magFilter="linear"] String optional

      How the texture is sampled when a texel covers more than one pixel. See the magFilter property for more info.

    • [wrapS="repeat"] String optional

      Wrap parameter for texture coordinate S. See the wrapS property for more info.

    • [wrapT="repeat"] String optional

      Wrap parameter for texture coordinate S. See the wrapT property for more info.

    • [flipY=false] Boolean optional

      Flips this Texture's source data along its vertical axis when true.

    • [translate=[0,0]] Array of Number optional

      2D translation vector that will be added to texture's S and T coordinates.

    • [scale=[1,1]] Array of Number optional

      2D scaling vector that will be applied to texture's S and T coordinates.

    • [rotate=0] Number optional

      Rotation, in degrees, that will be applied to texture's S and T coordinates.

Methods

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({
     type: "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 new configuration:

var material2 = component.create({ type: "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.

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

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

destroyed

Boolean

True as soon as this Component has been destroyed

flipY

Boolean

Flips this Texture's source data along its vertical axis when true.

Fires a flipY event on change.

Default: false

id

String final

Unique ID for this Component within its parent Scene.

image

HTMLImageElement

Indicates an HTML DOM Image object to source this Texture from.

Fires an image event on change.

Sets the src property to null.

Default: null

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.

magFilter

String

How this Texture is sampled when a texel covers more than one pixel.

Options are:

* **"nearest"** - Uses the value of the texture element that is nearest
                    (in Manhattan distance) to the center of the pixel being textured.
                    * **"linear"** - **(default)** - Uses the weighted average of the four texture elements that are
                    closest to the center of the pixel being textured.
                    

Fires a magFilter event on change.

Default: "linear"

metadata

Object

Arbitrary, user-defined metadata on this component.

minFilter

String

How this Texture is sampled when a texel covers less than one pixel.

Options are:

* **"nearest"** - Uses the value of the texture element that is nearest
                    (in Manhattan distance) to the center of the pixel being textured.
                    
                    * **"linear"** - Uses the weighted average of the four texture elements that are
                    closest to the center of the pixel being textured.
                    
                    * **"nearestMipmapNearest"** - Chooses the mipmap that most closely matches the
                    size of the pixel being textured and uses the "nearest" criterion (the texture
                    element nearest to the center of the pixel) to produce a texture value.
                    
                    * **"linearMipmapNearest"** - Chooses the mipmap that most closely matches the size of
                    the pixel being textured and uses the "linear" criterion (a weighted average of the
                    four texture elements that are closest to the center of the pixel) to produce a
                    texture value.
                    
                    * **"nearestMipmapLinear"** - Chooses the two mipmaps that most closely
                    match the size of the pixel being textured and uses the "nearest" criterion
                    (the texture element nearest to the center of the pixel) to produce a texture
                    value from each mipmap. The final texture value is a weighted average of those two
                    values.
                    
                    * **"linearMipmapLinear"** - **(default)** - Chooses the two mipmaps that most closely match the size
                    of the pixel being textured and uses the "linear" criterion (a weighted average
                    of the four texture elements that are closest to the center of the pixel) to
                    produce a texture value from each mipmap. The final texture value is a weighted
                    average of those two values.
                    

Fires a minFilter event on change.

Default: "linearMipmapLinear"

rotate

Number

Rotation, in degrees, that will be applied to this Texture's S and T coordinates.

Fires a rotate event on change.

Default: 0

scale

Array(Number)

2D scaling vector that will be applied to this Texture's S and T coordinates.

Fires a scale event on change.

Default: [1, 1]

scene

Scene final

The parent Scene that contains this Component.

src

String

Indicates a path to an image file to source this Texture from.

Fires a src event on change.

Sets the image property to null.

Default: null

string

String final

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

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.

translate

Array(Number)

2D translation vector that will be added to this Texture's S and T coordinates.

Fires a translate event on change.

Default: [0, 0]

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.

wrapS

String

Wrap parameter for this Texture's S coordinate.

Options are:

* **"clampToEdge"** -  causes *S* coordinates to be clamped to the size of the texture.
                    * **"mirroredRepeat"** - causes the *S* coordinate to be set to the fractional part of the texture coordinate
                    if the integer part of *S* is even; if the integer part of *S* is odd, then the *S* texture coordinate is
                    set to *1 - frac ⁡ S* , where *frac ⁡ S* represents the fractional part of *S*.
                    * **"repeat"** - **(default)** - causes the integer part of the *S* coordinate to be ignored; xeogl uses only the
                    fractional part, thereby creating a repeating pattern.
                    

Fires a wrapS event on change.

Default: "repeat"

wrapT

String

Wrap parameter for this Texture's T coordinate.

Options are:

* **"clampToEdge"** -  Causes *T* coordinates to be clamped to the size of the texture.
                    * **"mirroredRepeat"** - Causes the *T* coordinate to be set to the fractional part of the texture coordinate
                    if the integer part of *T* is even; if the integer part of *T* is odd, then the *T* texture coordinate is
                    set to *1 - frac ⁡ S* , where *frac ⁡ S* represents the fractional part of *T*.
                    * **"repeat"** - **(default)** - Causes the integer part of the *T* coordinate to be ignored; xeogl uses only the
                    fractional part, thereby creating a repeating pattern.
                    

Fires a wrapT event on change.

Default: "repeat"

Events

destroyed

Fired when this Component is destroyed.

flipY

Fired whenever this Texture's flipY property changes.

Event Payload:

  • value String

    The property's new value

image

Fired whenever this Texture's image property changes.

Event Payload:

  • value HTML Image

    The property's new value

image

Fired whenever this Texture's image property changes.

Event Payload:

  • value HTML Image

    The property's new value

loaded

Fired whenever this Texture has loaded the image file that its src property currently points to.

Event Payload:

  • value HTML Image

    The value of the src property

magFilter

Fired whenever this Texture's magFilter property changes.

Event Payload:

  • value String

    The property's new value

minFilter

Fired whenever this Texture's minFilter property changes.

Event Payload:

  • value String

    The property's new value

rotate

Fired whenever this Texture's rotate property changes.

Event Payload:

  • value Number

    The property's new value

scale

Fired whenever this Texture's scale property changes.

Event Payload:

  • value Array(Number)

    The property's new value

src

String

Fired whenever this Texture's src property changes.

Event Payload:

  • value Object

    The property's new value

translate

Fired whenever this Texture's translate property changes.

Event Payload:

  • value Array(Number)

    The property's new value

wrapS

Fired whenever this Texture's wrapS property changes.

Event Payload:

  • value String

    The property's new value

wrapT

Fired whenever this Texture's wrapT property changes.

Event Payload:

  • value String

    The property's new value