From d192d7af9f909b90371197b456b615d0030ad6da Mon Sep 17 00:00:00 2001 From: Jens Malmborg Date: Fri, 19 Aug 2022 19:38:50 +0200 Subject: [PATCH] 1.6.1 --- docs/classes/AABB.html | 20 ++--- docs/classes/Animation.html | 18 ++-- docs/classes/Camera.html | 62 ++++++------- docs/classes/CameraOrbitControl.html | 16 ++-- docs/classes/Color.html | 30 +++---- docs/classes/Container3D.html | 18 ++-- docs/classes/Cubemap.html | 10 +-- docs/classes/CubemapResource.html | 4 +- docs/classes/ImageBasedLighting.html | 14 +-- docs/classes/InstancedMesh3D.html | 20 ++--- docs/classes/InstancedModel.html | 22 ++--- docs/classes/InstancedStandardMaterial.html | 6 +- docs/classes/Joint.html | 20 ++--- docs/classes/Light.html | 28 +++--- docs/classes/LightingEnvironment.html | 14 +-- docs/classes/Mat4.html | 2 +- docs/classes/Material.html | 34 +++---- docs/classes/MaterialRenderPass.html | 14 +-- docs/classes/Matrix4.html | 32 +++---- docs/classes/Mesh3D.html | 56 ++++++------ docs/classes/MeshGeometry3D.html | 10 +-- docs/classes/MeshShader.html | 8 +- docs/classes/Model.html | 28 +++--- docs/classes/ObservablePoint3D.html | 26 +++--- docs/classes/ObservableQuaternion.html | 38 ++++---- docs/classes/PickingHitArea.html | 8 +- docs/classes/PickingInteraction.html | 10 +-- docs/classes/Plane.html | 2 +- docs/classes/PostProcessingSprite.html | 14 +-- docs/classes/Quat.html | 2 +- docs/classes/Ray.html | 2 +- docs/classes/ShadowCastingLight.html | 28 +++--- docs/classes/ShadowRenderPass.html | 12 +-- docs/classes/Skin.html | 10 +-- docs/classes/Skybox.html | 30 +++---- docs/classes/Sprite3D.html | 50 +++++------ docs/classes/SpriteBatchRenderer.html | 4 +- docs/classes/StandardMaterial.html | 90 +++++++++---------- .../StandardMaterialNormalTexture.html | 6 +- .../StandardMaterialOcclusionTexture.html | 6 +- docs/classes/StandardMaterialTexture.html | 6 +- docs/classes/StandardPipeline.html | 22 ++--- docs/classes/TextureTransform.html | 14 +-- docs/classes/Transform3D.html | 24 ++--- docs/classes/Vec3.html | 2 +- docs/classes/glTFAsset.html | 16 ++-- docs/enums/LightType.html | 6 +- docs/enums/MaterialRenderSortType.html | 2 +- docs/enums/ShadowQuality.html | 6 +- docs/enums/SpriteBillboardType.html | 6 +- docs/enums/StandardMaterialAlphaMode.html | 6 +- docs/enums/StandardMaterialDebugMode.html | 2 +- docs/index.html | 2 +- docs/interfaces/CubemapFaces.html | 12 +-- docs/interfaces/MaterialFactory.html | 4 +- docs/interfaces/MeshDestroyOptions.html | 2 +- docs/interfaces/MeshGeometryAttribute.html | 12 +-- docs/interfaces/MeshGeometryTarget.html | 4 +- .../PostProcessingSpriteOptions.html | 8 +- docs/interfaces/RenderPass.html | 8 +- .../interfaces/ShadowCastingLightOptions.html | 4 +- docs/interfaces/SphereGeometryOptions.html | 6 +- docs/interfaces/glTFResourceLoader.html | 4 +- docs/modules.html | 2 +- docs/modules/Debug.html | 2 +- package-lock.json | 4 +- package.json | 2 +- 67 files changed, 507 insertions(+), 505 deletions(-) diff --git a/docs/classes/AABB.html b/docs/classes/AABB.html index 16de898b..684de4ff 100644 --- a/docs/classes/AABB.html +++ b/docs/classes/AABB.html @@ -1,24 +1,24 @@ -AABB | Pixi3D - v1.6.0
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AABB

+AABB | Pixi3D - v1.6.1
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AABB

Axis-aligned bounding box.

-

Hierarchy

  • AABB

Index

Constructors

Accessors

Methods

Constructors

constructor

Accessors

center

Hierarchy

  • AABB

Index

Constructors

Accessors

Methods

Constructors

constructor

Accessors

center

extents

extents

max

max

min

min

size

size

Methods

encapsulate

  • encapsulate(point: { x: number; y: number; z: number }): void

Methods

encapsulate

  • encapsulate(point: { x: number; y: number; z: number }): void

  • Grows the bounding box to include the point.

    Parameters

    • point: { x: number; y: number; z: number }

      The point to include.

      -
      • x: number
      • y: number
      • z: number

    Returns void

Static from

  • from(source: { max: Float32Array; min: Float32Array }): AABB

Returns void

Static from

  • from(source: { max: Float32Array; min: Float32Array }): AABB

Properties

Readonly Abstract duration

duration: number

The duration (in seconds) of this animation.

-

loop

loop: boolean = false
+

loop

loop: boolean = false

A value indicating if the animation is looping.

-

Optional name

name?: string

Abstract position

position: number
+

Optional name

name?: string

Abstract position

position: number

The current position (in seconds) of this animation.

-

speed

speed: number = 1
+

speed

speed: number = 1

The speed that the animation will play at.

Static prefixed

prefixed: string | boolean

Methods

addListener

  • addListener(event: string | symbol, fn: ListenerFn, context?: any): Animation

  • Parameters

    • event: string | symbol
    • fn: ListenerFn
    • Optional context: any

    Returns Animation

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Calls each of the listeners registered for a given event.

    @@ -25,7 +25,7 @@

    Add a listener for a given event.

    Parameters

    • event: string | symbol
    • fn: ListenerFn
    • Optional context: any

    Returns Animation

once

  • once(event: string | symbol, fn: ListenerFn, context?: any): Animation

  • Add a one-time listener for a given event.

    -

    Parameters

    • event: string | symbol
    • fn: ListenerFn
    • Optional context: any

    Returns Animation

play

  • play(ticker?: Ticker): void

play

  • play(ticker?: Ticker): void

  • Starts playing the animation using the specified ticker.

    Parameters

    • ticker: Ticker = Ticker.shared

      The ticker to use for updating the animation. If a ticker @@ -34,9 +34,9 @@

      Remove all listeners, or those of the specified event.

      Parameters

      • Optional event: string | symbol

      Returns Animation

removeListener

  • removeListener(event: string | symbol, fn?: ListenerFn, context?: any, once?: boolean): Animation

  • Remove the listeners of a given event.

    -

    Parameters

    • event: string | symbol
    • Optional fn: ListenerFn
    • Optional context: any
    • Optional once: boolean

    Returns Animation

stop

  • stop(): void
  • +

    Parameters

    • event: string | symbol
    • Optional fn: ListenerFn
    • Optional context: any
    • Optional once: boolean

    Returns Animation

stop

  • stop(): void

update

  • update(delta: number): void

update

  • update(delta: number): void

screenToRay

  • screenToRay(x: number, y: number, viewSize?: { height: number; width: number }): undefined | Ray

  • Converts screen coordinates to a ray.

    Parameters

    • x: number

      Screen x coordinate.

      @@ -392,7 +392,7 @@

      Screen y coordinate.

    • viewSize: { height: number; width: number } = ...

      The size of the view when not rendering to the entire screen.

      -
      • height: number
      • width: number

    Returns undefined | Ray

screenToWorld

Returns undefined | Ray

screenToWorld

  • Converts screen coordinates to world coordinates.

    Parameters

    • x: number

      Screen x coordinate.

      @@ -476,7 +476,7 @@

updateTransform

  • updateTransform(): void

  • Updates the transform on all children of this container for rendering.

    -

    Returns void

worldToScreen

  • worldToScreen(x: number, y: number, z: number, point?: Point, viewSize?: { height: number; width: number }): Point

worldToScreen

  • worldToScreen(x: number, y: number, z: number, point?: Point, viewSize?: { height: number; width: number }): Point

Properties

allowControl

allowControl: boolean = true

Allows the camera to be controlled by user.

-

camera

camera: Camera = Camera.main

target

target: { x: number; y: number; z: number } = ...
+

camera

camera: Camera = Camera.main

target

target: { x: number; y: number; z: number } = ...

Target position (x, y, z) to orbit.

-

Type declaration

  • x: number
  • y: number
  • z: number

Accessors

angles

  • get angles(): ObservablePoint<undefined>

Accessors

angles

  • get angles(): ObservablePoint<undefined>

  • Orientation euler angles (x-axis and y-axis). The angle for the x-axis will be clamped between -85 and 85 degrees.

    -

    Returns ObservablePoint<undefined>

distance

  • get distance(): number
  • set distance(value: number): void

distance

  • get distance(): number
  • set distance(value: number): void

Methods

updateCamera

  • updateCamera(): void

Methods

updateCamera

  • updateCamera(): void

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/Color.html b/docs/classes/Color.html index e4654a89..9c25fd00 100644 --- a/docs/classes/Color.html +++ b/docs/classes/Color.html @@ -1,6 +1,6 @@ -Color | Pixi3D - v1.6.0
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Color

+Color | Pixi3D - v1.6.1
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Color

Represents a color containing RGBA components.

-

Hierarchy

  • Color

Index

Constructors

Accessors

Methods

Constructors

constructor

  • new Color(r?: number, g?: number, b?: number, a?: number): Color

Hierarchy

  • Color

Index

Constructors

Accessors

Methods

Constructors

constructor

  • new Color(r?: number, g?: number, b?: number, a?: number): Color

  • Creates a new color with the specified components (in range 0-1).

    Parameters

    • r: number = 0

      The R (red) component.

      @@ -10,31 +10,31 @@

      The B (blue) component.

    • a: number = 1

      The A (alpha) component.

      -

    Returns Color

Accessors

a

  • get a(): number
  • set a(value: number): void

Returns Color

Accessors

a

  • get a(): number
  • set a(value: number): void

b

  • get b(): number
  • set b(value: number): void

b

  • get b(): number
  • set b(value: number): void

g

  • get g(): number
  • set g(value: number): void

g

  • get g(): number
  • set g(value: number): void

r

  • get r(): number
  • set r(value: number): void

r

  • get r(): number
  • set r(value: number): void

rgb

  • get rgb(): Float32Array

rgb

  • get rgb(): Float32Array

  • The color as an typed array containing RGB.

    -

    Returns Float32Array

rgba

  • get rgba(): Float32Array

rgba

  • get rgba(): Float32Array

  • The color as an typed array containing RGBA.

    -

    Returns Float32Array

Methods

Static from

  • from(source: Float32Array | number[]): Color

Methods

Static from

  • from(source: Float32Array | number[]): Color

  • Creates a new color from the specified source.

    Parameters

    • source: Float32Array | number[]

      The source to create the color from.

      -

    Returns Color

Static fromBytes

  • fromBytes(r?: number, g?: number, b?: number, a?: number): Color

Returns Color

Static fromBytes

  • fromBytes(r?: number, g?: number, b?: number, a?: number): Color

  • Creates a new color with the specified components (in range 0-255).

    Parameters

    • r: number = 0

      The R (red) component.

      @@ -44,7 +44,7 @@

      The B (blue) component.

    • a: number = 255

      The A (alpha) component.

      -

    Returns Color

Static fromHex

  • fromHex(hex: string | number): Color

Returns Color

Static fromHex

  • fromHex(hex: string | number): Color

localTransform

mask

  • get mask(): null | Container<DisplayObject> | MaskData
  • set mask(value: null | Container<DisplayObject> | MaskData): void
  • +

    Parameters

    • value: number

    Returns void

localTransform

mask

  • get mask(): null | Container<DisplayObject> | MaskData
  • set mask(value: null | Container<DisplayObject> | MaskData): void

  • Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it. In PixiJS a regular mask must be a {@link PIXI.Graphics} or a {@link PIXI.Sprite} object. This allows for much faster masking in canvas as it @@ -120,15 +120,15 @@ is the projection of pivot in the parent's local space.

    By default, the pivot is the origin (0, 0).

    since

    4.0.0

    -

    Parameters

    • value: IPointData

    Returns void

position

rotation

  • get rotation(): number
  • set rotation(value: number): void
  • +

    Parameters

    • value: IPointData

    Returns void

position

rotation

  • get rotation(): number
  • set rotation(value: number): void

  • The rotation of the object in radians. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.

    Returns number

  • The rotation of the object in radians. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.

    -

    Parameters

    • value: number

    Returns void

rotationQuaternion

rotationQuaternion

scale

skew

  • get skew(): ObservablePoint<any>
  • set skew(value: IPointData): void

scale

skew

  • get skew(): ObservablePoint<any>
  • set skew(value: IPointData): void

  • The skew factor for the object in radians.

    since

    4.0.0

    Returns ObservablePoint<any>

  • @@ -138,7 +138,7 @@

    The width of the Container, setting this will actually modify the scale to achieve the value set.

    Returns number

  • The width of the Container, setting this will actually modify the scale to achieve the value set.

    -

    Parameters

    • value: number

    Returns void

worldTransform

worldVisible

  • get worldVisible(): boolean
  • +

    Parameters

    • value: number

    Returns void

worldTransform

worldVisible

  • get worldVisible(): boolean

  • Indicates if the object is globally visible.

    readonly

    Returns boolean

x

  • get x(): number
  • set x(value: number): void

  • The position of the displayObject on the x axis relative to the local coordinates of the parent. @@ -152,10 +152,10 @@

    Returns number

  • The position of the displayObject on the y axis relative to the local coordinates of the parent. An alias to position.y

    -

    Parameters

    • value: number

    Returns void

z

  • get z(): number
  • set z(value: number): void

z

  • get z(): number
  • set z(value: number): void

  • The position of the object on the z axis relative to the local coordinates of the parent.

    -

    Returns number

  • +

    Returns number

  • The position of the object on the z axis relative to the local coordinates of the parent.

    Parameters

    • value: number

    Returns void

zIndex

  • get zIndex(): number
  • set zIndex(value: number): void
  • diff --git a/docs/classes/Cubemap.html b/docs/classes/Cubemap.html index 33dde31b..9b7d35aa 100644 --- a/docs/classes/Cubemap.html +++ b/docs/classes/Cubemap.html @@ -1,4 +1,4 @@ -Cubemap | Pixi3D - v1.6.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Cubemap

    +Cubemap | Pixi3D - v1.6.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Cubemap

    Cubemap which supports multiple user specified mipmaps.

    Hierarchy

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    • new Cubemap(resource?: any, options?: IBaseTextureOptions<IAutoDetectOptions>): Cubemap

    • Parameters

      • Optional resource: any
      • Optional options: IBaseTextureOptions<IAutoDetectOptions>

        Collection of options

        @@ -68,7 +68,7 @@

        The width of the base texture set when the image has loaded

        readonly

    Static _globalBatch

    _globalBatch: number

    Global number of the texture batch, used by multi-texture renderers.

    -

    Static prefixed

    prefixed: string | boolean

    Accessors

    levels

    • get levels(): number

    Static prefixed

    prefixed: string | boolean

    Accessors

    levels

    • get levels(): number

    mipmap

    • get mipmap(): MIPMAP_MODES
    • set mipmap(value: MIPMAP_MODES): void

    • Mipmap mode of the texture, affects downscaled images

      @@ -92,7 +92,7 @@

      Returns WRAP_MODES

    • How the texture wraps

      default

      PIXI.settings.WRAP_MODE

      -

      Parameters

      • value: WRAP_MODES

      Returns void

    Static faces

    • get faces(): ["posx", "negx", "posy", "negy", "posz", "negz"]

    Static faces

    • get faces(): ["posx", "negx", "posy", "negy", "posz", "negz"]

    Methods

    addListener

    • addListener(event: string | symbol, fn: ListenerFn, context?: any): Cubemap

    • Parameters

      • event: string | symbol
      • fn: ListenerFn
      • Optional context: any

      Returns Cubemap

    castToBaseTexture

    • castToBaseTexture(): BaseTexture<Resource, IAutoDetectOptions>

    • Utility function for BaseTexture|Texture cast.

      @@ -202,7 +202,7 @@

    Returns BaseTexture<BufferResource, IAutoDetectOptions>

    • The resulting new BaseTexture
    -

Static fromColors

Static fromColors

  • Creates a new cubemap from the specified colors.

    Parameters

    • posx: Color

      The color for positive x.

      @@ -216,7 +216,7 @@

      The color for positive z.

    • negz: Color = posx

      The color for negative z.

      -

    Returns Cubemap

Static fromFaces

Returns Cubemap

Static fromFaces

style

  • style(renderer: Renderer): boolean

unbind

  • unbind(baseTexture: BaseTexture<Resource, IAutoDetectOptions>): void
  • +

Returns void

style

  • style(renderer: Renderer): boolean

unbind

  • unbind(baseTexture: BaseTexture<Resource, IAutoDetectOptions>): void

  • Unset the parent base texture.

    Parameters

    • baseTexture: BaseTexture<Resource, IAutoDetectOptions>

    Returns void

update

  • update(): void

Returns ImageBasedLighting

Properties

Optional lookupBrdf

lookupBrdf?: Texture<Resource>

BRDF integration map lookup texture.

-

Static defaultLookupBrdf

defaultLookupBrdf: Texture<Resource> = ...
+

Static defaultLookupBrdf

defaultLookupBrdf: Texture<Resource> = ...

The default BRDF integration map lookup texture.

-

Accessors

diffuse

Accessors

diffuse

specular

specular

valid

  • get valid(): boolean

valid

  • get valid(): boolean

Legend

  • Constructor
  • Property
  • Method
  • Accessor
  • Inherited constructor
  • Inherited property
  • Inherited accessor
  • Property
  • Method
  • Static property
  • Static method
  • Protected property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/InstancedMesh3D.html b/docs/classes/InstancedMesh3D.html index 0a591108..a52d69a7 100644 --- a/docs/classes/InstancedMesh3D.html +++ b/docs/classes/InstancedMesh3D.html @@ -1,4 +1,4 @@ -InstancedMesh3D | Pixi3D - v1.6.0
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class InstancedMesh3D

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

_bounds

_bounds: Bounds
+InstancedMesh3D | Pixi3D - v1.6.1
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class InstancedMesh3D

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

_bounds

_bounds: Bounds

The bounds object, this is used to calculate and store the bounds of the displayObject.

Protected _boundsID

_boundsID: number

Flags the cached bounds as dirty.

@@ -59,7 +59,7 @@

Also be aware of that this may not work nicely with the addChildAt() function, as the zIndex sorting may cause the child to automatically sorted to another position.

see

PIXI.settings.SORTABLE_CHILDREN

-

trackedPointers

trackedPointers: {}

Type declaration

  • [x: number]: InteractionTrackingData

transform

transform: Transform3D = ...

visible

visible: boolean
+

trackedPointers

trackedPointers: {}

Type declaration

  • [x: number]: InteractionTrackingData

transform

transform: Transform3D = ...

visible

visible: boolean

The visibility of the object. If false the object will not be drawn, and the updateTransform function will not be called.

Only affects recursive calls from parent. You can ask for bounds or call updateTransform manually.

@@ -78,7 +78,7 @@

The height of the Container, setting this will actually modify the scale to achieve the value set.

Returns number

  • The height of the Container, setting this will actually modify the scale to achieve the value set.

    -

    Parameters

    • value: number

    Returns void

    • localTransform

    mask

    • get mask(): null | Container<DisplayObject> | MaskData
    • set mask(value: null | Container<DisplayObject> | MaskData): void
    • +

      Parameters

      • value: number

      Returns void

    localTransform

    mask

    • get mask(): null | Container<DisplayObject> | MaskData
    • set mask(value: null | Container<DisplayObject> | MaskData): void

    • Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it. In PixiJS a regular mask must be a {@link PIXI.Graphics} or a {@link PIXI.Sprite} object. This allows for much faster masking in canvas as it @@ -118,15 +118,15 @@ is the projection of pivot in the parent's local space.

      By default, the pivot is the origin (0, 0).

      since

      4.0.0

      -

      Parameters

      • value: IPointData

      Returns void

    position

    rotation

    • get rotation(): number
    • set rotation(value: number): void
    • +

      Parameters

      • value: IPointData

      Returns void

    position

    rotation

    • get rotation(): number
    • set rotation(value: number): void

    • The rotation of the object in radians. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.

      Returns number

    • The rotation of the object in radians. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.

      -

      Parameters

      • value: number

      Returns void

    rotationQuaternion

    • +

      Parameters

      • value: number

      Returns void

    rotationQuaternion

    scale

    skew

    • get skew(): ObservablePoint<any>
    • set skew(value: IPointData): void

    scale

    skew

    • get skew(): ObservablePoint<any>
    • set skew(value: IPointData): void

    • The skew factor for the object in radians.

      since

      4.0.0

      Returns ObservablePoint<any>

    • @@ -136,7 +136,7 @@

      The width of the Container, setting this will actually modify the scale to achieve the value set.

      Returns number

    • The width of the Container, setting this will actually modify the scale to achieve the value set.

      -

      Parameters

      • value: number

      Returns void

    worldTransform

    worldVisible

    • get worldVisible(): boolean
    • +

      Parameters

      • value: number

      Returns void

    worldTransform

    worldVisible

    • get worldVisible(): boolean

    • Indicates if the object is globally visible.

      readonly

      Returns boolean

    x

    • get x(): number
    • set x(value: number): void

    • The position of the displayObject on the x axis relative to the local coordinates of the parent. @@ -150,10 +150,10 @@

      Returns number

    • The position of the displayObject on the y axis relative to the local coordinates of the parent. An alias to position.y

      -

      Parameters

      • value: number

      Returns void

    z

    • get z(): number
    • set z(value: number): void
    • +

      Parameters

      • value: number

      Returns void

    z

    • get z(): number
    • set z(value: number): void

    • The position of the object on the z axis relative to the local coordinates of the parent.

      -

      Returns number

    • +

      Returns number

    • The position of the object on the z axis relative to the local coordinates of the parent.

      Parameters

      • value: number

      Returns void

    zIndex

    • get zIndex(): number
    • set zIndex(value: number): void
    • @@ -200,7 +200,7 @@

      Recalculates the bounds of the container.

      This implementation will automatically fit the children's bounds into the calculation. Each child's bounds is limited to its mask's bounds or filterArea, if any is applied.

      -

      Returns void

    destroy

    • destroy(options: undefined | boolean | IDestroyOptions): void

    destroy

    • destroy(options: undefined | boolean | IDestroyOptions): void

    • Removes all internal references and listeners as well as removes children from the display list. Do not use a Container after calling destroy.

      Parameters

      • options: undefined | boolean | IDestroyOptions

      Returns void

    disableTempParent

    • disableTempParent(cacheParent: Container<DisplayObject>): void

    localTransform

    mask

    • get mask(): null | Container<DisplayObject> | MaskData
    • set mask(value: null | Container<DisplayObject> | MaskData): void
    • +

      Parameters

      • value: number

      Returns void

    localTransform

    mask

    • get mask(): null | Container<DisplayObject> | MaskData
    • set mask(value: null | Container<DisplayObject> | MaskData): void

    • Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it. In PixiJS a regular mask must be a {@link PIXI.Graphics} or a {@link PIXI.Sprite} object. This allows for much faster masking in canvas as it @@ -126,15 +126,15 @@ is the projection of pivot in the parent's local space.

      By default, the pivot is the origin (0, 0).

      since

      4.0.0

      -

      Parameters

      • value: IPointData

      Returns void

    position

    rotation

    • get rotation(): number
    • set rotation(value: number): void
    • +

      Parameters

      • value: IPointData

      Returns void

    position

    rotation

    • get rotation(): number
    • set rotation(value: number): void

    • The rotation of the object in radians. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.

      Returns number

    • The rotation of the object in radians. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.

      -

      Parameters

      • value: number

      Returns void

    rotationQuaternion

    • +

      Parameters

      • value: number

      Returns void

    rotationQuaternion

    scale

    skew

    • get skew(): ObservablePoint<any>
    • set skew(value: IPointData): void

    scale

    skew

    • get skew(): ObservablePoint<any>
    • set skew(value: IPointData): void

    • The skew factor for the object in radians.

      since

      4.0.0

      Returns ObservablePoint<any>

    • @@ -144,7 +144,7 @@

      The width of the Container, setting this will actually modify the scale to achieve the value set.

      Returns number

    • The width of the Container, setting this will actually modify the scale to achieve the value set.

      -

      Parameters

      • value: number

      Returns void

    worldTransform

    worldVisible

    • get worldVisible(): boolean
    • +

      Parameters

      • value: number

      Returns void

    worldTransform

    worldVisible

    • get worldVisible(): boolean

    • Indicates if the object is globally visible.

      readonly

      Returns boolean

    x

    • get x(): number
    • set x(value: number): void

    • The position of the displayObject on the x axis relative to the local coordinates of the parent. @@ -158,10 +158,10 @@

      Returns number

    • The position of the displayObject on the y axis relative to the local coordinates of the parent. An alias to position.y

      -

      Parameters

      • value: number

      Returns void

    z

    • get z(): number
    • set z(value: number): void
    • +

      Parameters

      • value: number

      Returns void

    z

    • get z(): number
    • set z(value: number): void

    • The position of the object on the z axis relative to the local coordinates of the parent.

      -

      Returns number

    • +

      Returns number

    • The position of the object on the z axis relative to the local coordinates of the parent.

      Parameters

      • value: number

      Returns void

    zIndex

    • get zIndex(): number
    • set zIndex(value: number): void

    Properties

    baseColor

    baseColor: Color

    The base color of the material.

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Inherited constructor
    • Inherited property
    • Inherited accessor
    • Property
    • Method
    • Static property
    • Static method
    • Protected property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Joint.html b/docs/classes/Joint.html index 2d710ac9..2fed6cf4 100644 --- a/docs/classes/Joint.html +++ b/docs/classes/Joint.html @@ -1,6 +1,6 @@ -Joint | Pixi3D - v1.6.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Joint

    +Joint | Pixi3D - v1.6.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Joint

    Represents a joint used for vertex skinning.

    -

    Hierarchy

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    • new Joint(inverseBindMatrix: Float32Array): Joint

    Hierarchy

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    • new Joint(inverseBindMatrix: Float32Array): Joint

    • Creates a new joint.

      Parameters

      • inverseBindMatrix: Float32Array

        The inverse of the global transform matrix.

        @@ -65,7 +65,7 @@

        Also be aware of that this may not work nicely with the addChildAt() function, as the zIndex sorting may cause the child to automatically sorted to another position.

        see

        PIXI.settings.SORTABLE_CHILDREN

        -

    trackedPointers

    trackedPointers: {}

    Type declaration

    • [x: number]: InteractionTrackingData

    transform

    transform: Transform3D = ...

    visible

    visible: boolean
    +

    trackedPointers

    trackedPointers: {}

    Type declaration

    • [x: number]: InteractionTrackingData

    transform

    transform: Transform3D = ...

    visible

    visible: boolean

    The visibility of the object. If false the object will not be drawn, and the updateTransform function will not be called.

    Only affects recursive calls from parent. You can ask for bounds or call updateTransform manually.

    @@ -84,7 +84,7 @@

    The height of the Container, setting this will actually modify the scale to achieve the value set.

    Returns number

  • The height of the Container, setting this will actually modify the scale to achieve the value set.

    -

    Parameters

    • value: number

    Returns void

    • localTransform

    mask

    • get mask(): null | Container<DisplayObject> | MaskData
    • set mask(value: null | Container<DisplayObject> | MaskData): void
    • +

      Parameters

      • value: number

      Returns void

    localTransform

    mask

    • get mask(): null | Container<DisplayObject> | MaskData
    • set mask(value: null | Container<DisplayObject> | MaskData): void

    • Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it. In PixiJS a regular mask must be a {@link PIXI.Graphics} or a {@link PIXI.Sprite} object. This allows for much faster masking in canvas as it @@ -124,15 +124,15 @@ is the projection of pivot in the parent's local space.

      By default, the pivot is the origin (0, 0).

      since

      4.0.0

      -

      Parameters

      • value: IPointData

      Returns void

    position

    rotation

    • get rotation(): number
    • set rotation(value: number): void
    • +

      Parameters

      • value: IPointData

      Returns void

    position

    rotation

    • get rotation(): number
    • set rotation(value: number): void

    • The rotation of the object in radians. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.

      Returns number

    • The rotation of the object in radians. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.

      -

      Parameters

      • value: number

      Returns void

    rotationQuaternion

    • +

      Parameters

      • value: number

      Returns void

    rotationQuaternion

    scale

    skew

    • get skew(): ObservablePoint<any>
    • set skew(value: IPointData): void

    scale

    skew

    • get skew(): ObservablePoint<any>
    • set skew(value: IPointData): void

    • The skew factor for the object in radians.

      since

      4.0.0

      Returns ObservablePoint<any>

    • @@ -142,7 +142,7 @@

      The width of the Container, setting this will actually modify the scale to achieve the value set.

      Returns number

    • The width of the Container, setting this will actually modify the scale to achieve the value set.

      -

      Parameters

      • value: number

      Returns void

    worldTransform

    worldVisible

    • get worldVisible(): boolean
    • +

      Parameters

      • value: number

      Returns void

    worldTransform

    worldVisible

    • get worldVisible(): boolean

    • Indicates if the object is globally visible.

      readonly

      Returns boolean

    x

    • get x(): number
    • set x(value: number): void

    • The position of the displayObject on the x axis relative to the local coordinates of the parent. @@ -156,10 +156,10 @@

      Returns number

    • The position of the displayObject on the y axis relative to the local coordinates of the parent. An alias to position.y

      -

      Parameters

      • value: number

      Returns void

    z

    • get z(): number
    • set z(value: number): void
    • +

      Parameters

      • value: number

      Returns void

    z

    • get z(): number
    • set z(value: number): void

    • The position of the object on the z axis relative to the local coordinates of the parent.

      -

      Returns number

    • +

      Returns number

    • The position of the object on the z axis relative to the local coordinates of the parent.

      Parameters

      • value: number

      Returns void

    zIndex

    • get zIndex(): number
    • set zIndex(value: number): void

    localTransform

    mask

    • get mask(): null | Container<DisplayObject> | MaskData
    • set mask(value: null | Container<DisplayObject> | MaskData): void
    • +

      Parameters

      • value: number

      Returns void

    localTransform

    mask

    • get mask(): null | Container<DisplayObject> | MaskData
    • set mask(value: null | Container<DisplayObject> | MaskData): void

    • Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it. In PixiJS a regular mask must be a {@link PIXI.Graphics} or a {@link PIXI.Sprite} object. This allows for much faster masking in canvas as it @@ -130,15 +130,15 @@ is the projection of pivot in the parent's local space.

      By default, the pivot is the origin (0, 0).

      since

      4.0.0

      -

      Parameters

      • value: IPointData

      Returns void

    position

    rotation

    • get rotation(): number
    • set rotation(value: number): void
    • +

      Parameters

      • value: IPointData

      Returns void

    position

    rotation

    • get rotation(): number
    • set rotation(value: number): void

    • The rotation of the object in radians. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.

      Returns number

    • The rotation of the object in radians. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.

      -

      Parameters

      • value: number

      Returns void

    rotationQuaternion

    • +

      Parameters

      • value: number

      Returns void

    rotationQuaternion

    scale

    skew

    • get skew(): ObservablePoint<any>
    • set skew(value: IPointData): void

    scale

    skew

    • get skew(): ObservablePoint<any>
    • set skew(value: IPointData): void

    • The skew factor for the object in radians.

      since

      4.0.0

      Returns ObservablePoint<any>

    • @@ -148,7 +148,7 @@

      The width of the Container, setting this will actually modify the scale to achieve the value set.

      Returns number

    • The width of the Container, setting this will actually modify the scale to achieve the value set.

      -

      Parameters

      • value: number

      Returns void

    worldTransform

    worldVisible

    • get worldVisible(): boolean
    • +

      Parameters

      • value: number

      Returns void

    worldTransform

    worldVisible

    • get worldVisible(): boolean

    • Indicates if the object is globally visible.

      readonly

      Returns boolean

    x

    • get x(): number
    • set x(value: number): void

    • The position of the displayObject on the x axis relative to the local coordinates of the parent. @@ -162,10 +162,10 @@

      Returns number

    • The position of the displayObject on the y axis relative to the local coordinates of the parent. An alias to position.y

      -

      Parameters

      • value: number

      Returns void

    z

    • get z(): number
    • set z(value: number): void
    • +

      Parameters

      • value: number

      Returns void

    z

    • get z(): number
    • set z(value: number): void

    • The position of the object on the z axis relative to the local coordinates of the parent.

      -

      Returns number

    • +

      Returns number

    • The position of the object on the z axis relative to the local coordinates of the parent.

      Parameters

      • value: number

      Returns void

    zIndex

    • get zIndex(): number
    • set zIndex(value: number): void

    Returns LightingEnvironment

    Properties

    Optional imageBasedLighting

    imageBasedLighting?: ImageBasedLighting

    The image-based lighting object.

    -

    lights

    lights: Light[] = []
    +

    lights

    lights: Light[] = []

    The lights affecting this lighting environment.

    -

    renderer

    renderer: Renderer

    Static main

    main: LightingEnvironment
    +

    renderer

    renderer: Renderer

    Static main

    main: LightingEnvironment

    The main lighting environment which is used by default.

    -

    Accessors

    valid

    • get valid(): boolean

    Accessors

    valid

    • get valid(): boolean

    Methods

    destroy

    • destroy(): void

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Inherited constructor
    • Inherited property
    • Inherited accessor
    • Property
    • Method
    • Static property
    • Static method
    • Protected property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns boolean

    Methods

    destroy

    • destroy(): void

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Inherited constructor
    • Inherited property
    • Inherited accessor
    • Property
    • Method
    • Static property
    • Static method
    • Protected property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Mat4.html b/docs/classes/Mat4.html index c915f557..31f629a1 100644 --- a/docs/classes/Mat4.html +++ b/docs/classes/Mat4.html @@ -1 +1 @@ -Mat4 | Pixi3D - v1.6.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Mat4

    Hierarchy

    • Mat4

    Index

    Constructors

    Methods

    Constructors

    constructor

    Methods

    Static copy

    • copy(a: Float32Array, out?: Float32Array): Float32Array

    • Parameters

      • a: Float32Array
      • out: Float32Array = ...

      Returns Float32Array

    Static create

    • create(): Float32Array

    Static fromQuat

    • fromQuat(q: Float32Array, out?: Float32Array): Float32Array

    • Parameters

      • q: Float32Array
      • out: Float32Array = ...

      Returns Float32Array

    Static fromRotation

    • fromRotation(rad: number, axis: Float32Array, out?: Float32Array): Float32Array

    • Parameters

      • rad: number
      • axis: Float32Array
      • out: Float32Array = ...

      Returns Float32Array

    Static fromRotationTranslationScale

    • fromRotationTranslationScale(q: Float32Array, v: Float32Array, s: Float32Array, out?: Float32Array): Float32Array

    • Parameters

      • q: Float32Array
      • v: Float32Array
      • s: Float32Array
      • out: Float32Array = ...

      Returns Float32Array

    Static fromScaling

    • fromScaling(v: Float32Array, out?: Float32Array): Float32Array

    • Parameters

      • v: Float32Array
      • out: Float32Array = ...

      Returns Float32Array

    Static fromTranslation

    • fromTranslation(v: Float32Array, out?: Float32Array): Float32Array

    • Parameters

      • v: Float32Array
      • out: Float32Array = ...

      Returns Float32Array

    Static getRotation

    • getRotation(mat: Float32Array, out?: Float32Array): Float32Array

    • Parameters

      • mat: Float32Array
      • out: Float32Array = ...

      Returns Float32Array

    Static getScaling

    • getScaling(mat: Float32Array, out?: Float32Array): Float32Array

    • Parameters

      • mat: Float32Array
      • out: Float32Array = ...

      Returns Float32Array

    Static getTranslation

    • getTranslation(mat: Float32Array, out?: Float32Array): Float32Array

    • Parameters

      • mat: Float32Array
      • out: Float32Array = ...

      Returns Float32Array

    Static identity

    • identity(out?: Float32Array): Float32Array

    Static invert

    • invert(a: Float32Array, out?: Float32Array): Float32Array

    • Parameters

      • a: Float32Array
      • out: Float32Array = ...

      Returns Float32Array

    Static lookAt

    • lookAt(eye: Float32Array, center: Float32Array, up: Float32Array, out?: Float32Array): Float32Array

    • Parameters

      • eye: Float32Array
      • center: Float32Array
      • up: Float32Array
      • out: Float32Array = ...

      Returns Float32Array

    Static multiply

    • multiply(a: Float32Array, b: Float32Array, out?: Float32Array): Float32Array

    • Parameters

      • a: Float32Array
      • b: Float32Array
      • out: Float32Array = ...

      Returns Float32Array

    Static ortho

    • ortho(left: number, right: number, bottom: number, top: number, near: number, far: number, out?: Float32Array): Float32Array

    • Parameters

      • left: number
      • right: number
      • bottom: number
      • top: number
      • near: number
      • far: number
      • out: Float32Array = ...

      Returns Float32Array

    Static perspective

    • perspective(fovy: number, aspect: number, near: number, far: number, out?: Float32Array): Float32Array

    • Parameters

      • fovy: number
      • aspect: number
      • near: number
      • far: number
      • out: Float32Array = ...

      Returns Float32Array

    Static rotate

    • rotate(a: Float32Array, rad: number, axis: Float32Array, out?: Float32Array): Float32Array

    • Parameters

      • a: Float32Array
      • rad: number
      • axis: Float32Array
      • out: Float32Array = ...

      Returns Float32Array

    Static rotateX

    • rotateX(a: Float32Array, rad: number, out?: Float32Array): Float32Array

    • Parameters

      • a: Float32Array
      • rad: number
      • out: Float32Array = ...

      Returns Float32Array

    Static rotateY

    • rotateY(a: Float32Array, rad: number, out?: Float32Array): Float32Array

    • Parameters

      • a: Float32Array
      • rad: number
      • out: Float32Array = ...

      Returns Float32Array

    Static rotateZ

    • rotateZ(a: Float32Array, rad: number, out?: Float32Array): Float32Array

    • Parameters

      • a: Float32Array
      • rad: number
      • out: Float32Array = ...

      Returns Float32Array

    Static scale

    • scale(a: Float32Array, v: Float32Array, out?: Float32Array): Float32Array

    • Parameters

      • a: Float32Array
      • v: Float32Array
      • out: Float32Array = ...

      Returns Float32Array

    Static targetTo

    • targetTo(eye: Float32Array, target: Float32Array, up: Float32Array, out?: Float32Array): Float32Array

    • Parameters

      • eye: Float32Array
      • target: Float32Array
      • up: Float32Array
      • out: Float32Array = ...

      Returns Float32Array

    Static translate

    • translate(mat: Float32Array, v: Float32Array, out?: Float32Array): Float32Array

    • Parameters

      • mat: Float32Array
      • v: Float32Array
      • out: Float32Array = ...

      Returns Float32Array

    Static transpose

    • transpose(a: Float32Array, out?: Float32Array): Float32Array

    • Parameters

      • a: Float32Array
      • out: Float32Array = ...

      Returns Float32Array

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Inherited constructor
    • Inherited property
    • Inherited accessor
    • Property
    • Method
    • Static property
    • Static method
    • Protected property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Mat4 | Pixi3D - v1.6.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Mat4

    Hierarchy

    • Mat4

    Index

    Constructors

    Methods

    Constructors

    constructor

    Methods

    Static copy

    • copy(a: Float32Array, out?: Float32Array): Float32Array

    • Parameters

      • a: Float32Array
      • out: Float32Array = ...

      Returns Float32Array

    Static create

    • create(): Float32Array

    Static fromQuat

    • fromQuat(q: Float32Array, out?: Float32Array): Float32Array

    • Parameters

      • q: Float32Array
      • out: Float32Array = ...

      Returns Float32Array

    Static fromRotation

    • fromRotation(rad: number, axis: Float32Array, out?: Float32Array): Float32Array

    • Parameters

      • rad: number
      • axis: Float32Array
      • out: Float32Array = ...

      Returns Float32Array

    Static fromRotationTranslationScale

    • fromRotationTranslationScale(q: Float32Array, v: Float32Array, s: Float32Array, out?: Float32Array): Float32Array

    • Parameters

      • q: Float32Array
      • v: Float32Array
      • s: Float32Array
      • out: Float32Array = ...

      Returns Float32Array

    Static fromScaling

    • fromScaling(v: Float32Array, out?: Float32Array): Float32Array

    • Parameters

      • v: Float32Array
      • out: Float32Array = ...

      Returns Float32Array

    Static fromTranslation

    • fromTranslation(v: Float32Array, out?: Float32Array): Float32Array

    • Parameters

      • v: Float32Array
      • out: Float32Array = ...

      Returns Float32Array

    Static getRotation

    • getRotation(mat: Float32Array, out?: Float32Array): Float32Array

    • Parameters

      • mat: Float32Array
      • out: Float32Array = ...

      Returns Float32Array

    Static getScaling

    • getScaling(mat: Float32Array, out?: Float32Array): Float32Array

    • Parameters

      • mat: Float32Array
      • out: Float32Array = ...

      Returns Float32Array

    Static getTranslation

    • getTranslation(mat: Float32Array, out?: Float32Array): Float32Array

    • Parameters

      • mat: Float32Array
      • out: Float32Array = ...

      Returns Float32Array

    Static identity

    • identity(out?: Float32Array): Float32Array

    Static invert

    • invert(a: Float32Array, out?: Float32Array): Float32Array

    • Parameters

      • a: Float32Array
      • out: Float32Array = ...

      Returns Float32Array

    Static lookAt

    • lookAt(eye: Float32Array, center: Float32Array, up: Float32Array, out?: Float32Array): Float32Array

    • Parameters

      • eye: Float32Array
      • center: Float32Array
      • up: Float32Array
      • out: Float32Array = ...

      Returns Float32Array

    Static multiply

    • multiply(a: Float32Array, b: Float32Array, out?: Float32Array): Float32Array

    • Parameters

      • a: Float32Array
      • b: Float32Array
      • out: Float32Array = ...

      Returns Float32Array

    Static ortho

    • ortho(left: number, right: number, bottom: number, top: number, near: number, far: number, out?: Float32Array): Float32Array

    • Parameters

      • left: number
      • right: number
      • bottom: number
      • top: number
      • near: number
      • far: number
      • out: Float32Array = ...

      Returns Float32Array

    Static perspective

    • perspective(fovy: number, aspect: number, near: number, far: number, out?: Float32Array): Float32Array

    • Parameters

      • fovy: number
      • aspect: number
      • near: number
      • far: number
      • out: Float32Array = ...

      Returns Float32Array

    Static rotate

    • rotate(a: Float32Array, rad: number, axis: Float32Array, out?: Float32Array): Float32Array

    • Parameters

      • a: Float32Array
      • rad: number
      • axis: Float32Array
      • out: Float32Array = ...

      Returns Float32Array

    Static rotateX

    • rotateX(a: Float32Array, rad: number, out?: Float32Array): Float32Array

    • Parameters

      • a: Float32Array
      • rad: number
      • out: Float32Array = ...

      Returns Float32Array

    Static rotateY

    • rotateY(a: Float32Array, rad: number, out?: Float32Array): Float32Array

    • Parameters

      • a: Float32Array
      • rad: number
      • out: Float32Array = ...

      Returns Float32Array

    Static rotateZ

    • rotateZ(a: Float32Array, rad: number, out?: Float32Array): Float32Array

    • Parameters

      • a: Float32Array
      • rad: number
      • out: Float32Array = ...

      Returns Float32Array

    Static scale

    • scale(a: Float32Array, v: Float32Array, out?: Float32Array): Float32Array

    • Parameters

      • a: Float32Array
      • v: Float32Array
      • out: Float32Array = ...

      Returns Float32Array

    Static targetTo

    • targetTo(eye: Float32Array, target: Float32Array, up: Float32Array, out?: Float32Array): Float32Array

    • Parameters

      • eye: Float32Array
      • target: Float32Array
      • up: Float32Array
      • out: Float32Array = ...

      Returns Float32Array

    Static translate

    • translate(mat: Float32Array, v: Float32Array, out?: Float32Array): Float32Array

    • Parameters

      • mat: Float32Array
      • v: Float32Array
      • out: Float32Array = ...

      Returns Float32Array

    Static transpose

    • transpose(a: Float32Array, out?: Float32Array): Float32Array

    • Parameters

      • a: Float32Array
      • out: Float32Array = ...

      Returns Float32Array

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Inherited constructor
    • Inherited property
    • Inherited accessor
    • Property
    • Method
    • Static property
    • Static method
    • Protected property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Material.html b/docs/classes/Material.html index 85b0bb8f..e50f8abc 100644 --- a/docs/classes/Material.html +++ b/docs/classes/Material.html @@ -1,55 +1,55 @@ -Material | Pixi3D - v1.6.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Material

    +Material | Pixi3D - v1.6.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Material

    Materials are used to render a mesh with a specific visual appearance.

    -

    Hierarchy

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    Properties

    Protected _renderSortType

    _renderSortType: MaterialRenderSortType = MaterialRenderSortType.opaque

    Protected Optional _shader

    _shader?: MeshShader

    drawMode

    drawMode: DRAW_MODES = DRAW_MODES.TRIANGLES
    +

    Hierarchy

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    Properties

    Protected _renderSortType

    _renderSortType: MaterialRenderSortType = MaterialRenderSortType.opaque

    Protected Optional _shader

    _shader?: MeshShader

    drawMode

    drawMode: DRAW_MODES = DRAW_MODES.TRIANGLES

    Draw mode used to render a mesh.

    -

    renderSortType

    renderSortType: MaterialRenderSortType = MaterialRenderSortType.opaque
    +

    renderSortType

    renderSortType: MaterialRenderSortType = MaterialRenderSortType.opaque

    Sort type used to render a mesh. Transparent materials will be rendered after opaque materials.

    -

    state

    state: State & { clockwiseFrontFace: boolean; culling: boolean; depthTest: boolean } = ...
    +

    state

    state: State & { clockwiseFrontFace: boolean; culling: boolean; depthTest: boolean } = ...

    State used to render a mesh.

    -

    Accessors

    blendMode

    • get blendMode(): BLEND_MODES
    • set blendMode(value: BLEND_MODES): void

    Accessors

    blendMode

    • get blendMode(): BLEND_MODES
    • set blendMode(value: BLEND_MODES): void

    depthMask

    • get depthMask(): boolean
    • set depthMask(value: boolean): void

    depthMask

    • get depthMask(): boolean
    • set depthMask(value: boolean): void

    • Value indicating if writing into the depth buffer is enabled or disabled. Depth mask feature is only available in PixiJS 6.0+ and won't have any effects in previous versions.

      -

      Returns boolean

    • +

      Returns boolean

    • Value indicating if writing into the depth buffer is enabled or disabled. Depth mask feature is only available in PixiJS 6.0+ and won't have any effects in previous versions.

      -

      Parameters

      • value: boolean

      Returns void

    doubleSided

    • get doubleSided(): boolean
    • set doubleSided(value: boolean): void

    doubleSided

    • get doubleSided(): boolean
    • set doubleSided(value: boolean): void

    isInstancingSupported

    • get isInstancingSupported(): boolean

    isInstancingSupported

    • get isInstancingSupported(): boolean

    Methods

    createInstance

    • createInstance(): unknown

    Methods

    createInstance

    • createInstance(): unknown

    createShader

    createShader

    • Creates a shader used to render the specified mesh.

      Parameters

      • mesh: Mesh3D

        The mesh to create the shader for.

      • renderer: Renderer

        The renderer to use.

        -

      Returns undefined | MeshShader

    destroy

    • destroy(): void

    Returns undefined | MeshShader

    destroy

    • destroy(): void

    render

    • render(mesh: Mesh3D, renderer: Renderer): void

    render

    • render(mesh: Mesh3D, renderer: Renderer): void

    Optional updateUniforms

    Returns void

    Optional updateUniforms

    Static from

    Returns void

    Static from

    Properties

    Optional clearColor

    clearColor?: Color = ...

    The color (r,g,b,a) used for clearing the render texture. If this value is empty, the render texture will not be cleared.

    name

    name: string

    The name of the render pass.

    -

    renderer

    renderer: Renderer

    Accessors

    renderTexture

    • get renderTexture(): undefined | RenderTexture
    • set renderTexture(value: undefined | RenderTexture): void

    renderer

    renderer: Renderer

    Accessors

    renderTexture

    • get renderTexture(): undefined | RenderTexture
    • set renderTexture(value: undefined | RenderTexture): void

    Methods

    clear

    • clear(): void

    Methods

    clear

    • clear(): void

    render

    • render(meshes: Mesh3D[]): void

    render

    • render(meshes: Mesh3D[]): void

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Inherited constructor
    • Inherited property
    • Inherited accessor
    • Property
    • Method
    • Static property
    • Static method
    • Protected property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Matrix4.html b/docs/classes/Matrix4.html index df02f58e..14159c10 100644 --- a/docs/classes/Matrix4.html +++ b/docs/classes/Matrix4.html @@ -1,35 +1,35 @@ -Matrix4 | Pixi3D - v1.6.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Matrix4

    +Matrix4 | Pixi3D - v1.6.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Matrix4

    Represents a 4x4 matrix.

    -

    Hierarchy

    • Matrix
      • Matrix4

    Implements

    • TransformId

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    • new Matrix4(array?: ArrayLike<number>): Matrix4

    Hierarchy

    • Matrix
      • Matrix4

    Implements

    • TransformId

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    • new Matrix4(array?: ArrayLike<number>): Matrix4

    • Creates a new transform matrix using the specified matrix array.

      Parameters

      • Optional array: ArrayLike<number>

        The matrix array, expected length is 16. If empty, an identity matrix is used by default.

      Returns Matrix4

    Properties

    a

    a: number
    default

    1

    -

    array

    array: Float32Array
    +

    array

    array: Float32Array

    The array containing the matrix data.

    b

    b: number
    default

    0

    c

    c: number
    default

    0

    d

    d: number
    default

    1

    tx

    tx: number
    default

    0

    ty

    ty: number
    default

    0

    -

    Accessors

    backward

    • get backward(): Float32Array

    Accessors

    backward

    • get backward(): Float32Array

    down

    • get down(): Float32Array

    down

    • get down(): Float32Array

    forward

    • get forward(): Float32Array

    forward

    • get forward(): Float32Array

    left

    • get left(): Float32Array

    left

    • get left(): Float32Array

    position

    • get position(): Float32Array

    position

    • get position(): Float32Array

    right

    • get right(): Float32Array

    right

    • get right(): Float32Array

    rotation

    • get rotation(): Float32Array

    rotation

    • get rotation(): Float32Array

    scaling

    • get scaling(): Float32Array

    scaling

    • get scaling(): Float32Array

    transformId

    • get transformId(): number

    up

    • get up(): Float32Array

    transformId

    • get transformId(): number

    up

    • get up(): Float32Array

    Static IDENTITY

    • get IDENTITY(): Matrix

    • A default (identity) matrix

      @@ -55,7 +55,7 @@

    clone

    • clone(): Matrix

    • Creates a new Matrix object with the same values as this one.

      Returns Matrix

      A copy of this matrix. Good for chaining method calls.

      -

    copyFrom

    copyTo

    • copyTo(matrix: Matrix): Matrix
    • +

    copyFrom

    copyTo

    • copyTo(matrix: Matrix): Matrix

    • Changes the values of the given matrix to be the same as the ones in this matrix

      Parameters

      • matrix: Matrix

        The matrix to copy to.

        @@ -81,7 +81,7 @@

    invert

    • Inverts this matrix

      Returns Matrix4

      This matrix. Good for chaining method calls.

      -

    multiply

    multiply

    • Multiplies this matrix with another matrix.

      Parameters

      • matrix: Matrix4

        The matrix to multiply with.

        @@ -117,7 +117,7 @@
      • ty: number

        Matrix component

      Returns Matrix4

      This matrix. Good for chaining method calls.

      -

    setFromRotationPositionScale

    setFromRotationPositionScale

    toArray

    • toArray(transpose: boolean, out?: Float32Array): Float32Array

    • Parameters

      • transpose: boolean
      • Optional out: Float32Array

      Returns Float32Array

    toString

    • toString(): string

    • Returns string

    translate

    • translate(x: number, y: number): Matrix4
    • +

    toArray

    • toArray(transpose: boolean, out?: Float32Array): Float32Array

    • Parameters

      • transpose: boolean
      • Optional out: Float32Array

      Returns Float32Array

    toString

    • toString(): string

    • Returns string

    translate

    • translate(x: number, y: number): Matrix4

    instances

    instances

    localTransform

    mask

    • get mask(): null | Container<DisplayObject> | MaskData
    • set mask(value: null | Container<DisplayObject> | MaskData): void
    • +

      Returns InstancedMesh3D[]

    localTransform

    mask

    • get mask(): null | Container<DisplayObject> | MaskData
    • set mask(value: null | Container<DisplayObject> | MaskData): void

    • Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it. In PixiJS a regular mask must be a {@link PIXI.Graphics} or a {@link PIXI.Sprite} object. This allows for much faster masking in canvas as it @@ -138,15 +138,15 @@ is the projection of pivot in the parent's local space.

      By default, the pivot is the origin (0, 0).

      since

      4.0.0

      -

      Parameters

      • value: IPointData

      Returns void

    position

    rotation

    • get rotation(): number
    • set rotation(value: number): void
    • +

      Parameters

      • value: IPointData

      Returns void

    position

    rotation

    • get rotation(): number
    • set rotation(value: number): void

    • The rotation of the object in radians. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.

      Returns number

    • The rotation of the object in radians. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.

      -

      Parameters

      • value: number

      Returns void

    rotationQuaternion

    • +

      Parameters

      • value: number

      Returns void

    rotationQuaternion

    scale

    skew

    • get skew(): ObservablePoint<any>
    • set skew(value: IPointData): void

    scale

    skew

    • get skew(): ObservablePoint<any>
    • set skew(value: IPointData): void

    • The skew factor for the object in radians.

      since

      4.0.0

      Returns ObservablePoint<any>

    • @@ -156,7 +156,7 @@

      The width of the Container, setting this will actually modify the scale to achieve the value set.

      Returns number

    • The width of the Container, setting this will actually modify the scale to achieve the value set.

      -

      Parameters

      • value: number

      Returns void

    worldTransform

    worldVisible

    • get worldVisible(): boolean
    • +

      Parameters

      • value: number

      Returns void

    worldTransform

    worldVisible

    • get worldVisible(): boolean

    • Indicates if the object is globally visible.

      readonly

      Returns boolean

    x

    • get x(): number
    • set x(value: number): void

    • The position of the displayObject on the x axis relative to the local coordinates of the parent. @@ -170,10 +170,10 @@

      Returns number

    • The position of the displayObject on the y axis relative to the local coordinates of the parent. An alias to position.y

      -

      Parameters

      • value: number

      Returns void

    z

    • get z(): number
    • set z(value: number): void
    • +

      Parameters

      • value: number

      Returns void

    z

    • get z(): number
    • set z(value: number): void

    • The position of the object on the z axis relative to the local coordinates of the parent.

      -

      Returns number

    • +

      Returns number

    • The position of the object on the z axis relative to the local coordinates of the parent.

      Parameters

      • value: number

      Returns void

    zIndex

    • get zIndex(): number
    • set zIndex(value: number): void
    • @@ -193,7 +193,7 @@ calculate the bounds of this specific object (not including children).

      Returns void

    Protected _recursivePostUpdateTransform

    • _recursivePostUpdateTransform(): void

    • Recursively updates transform of all objects from the root to this one internal function for toLocal()

      -

      Returns void

    _render

    • _render(renderer: Renderer): void

    _render

    • _render(renderer: Renderer): void

    Protected _renderWithCulling

    • _renderWithCulling(renderer: Renderer): void

    • Renders this object and its children with culling.

      @@ -218,11 +218,11 @@

      Recalculates the bounds of the container.

      This implementation will automatically fit the children's bounds into the calculation. Each child's bounds is limited to its mask's bounds or filterArea, if any is applied.

      -

      Returns void

    createInstance

    createInstance

    destroy

    destroy

    disableRenderPass

    • disableRenderPass(name: string): void

    disableRenderPass

    • disableRenderPass(name: string): void

    • Disables the render pass with the specified name.

      Parameters

      • name: string

        The name of the render pass to disable.

        @@ -232,7 +232,7 @@

        Actual parent of element

      Returns void

    emit

    • emit(event: string | symbol, ...args: any[]): boolean

    • Calls each of the listeners registered for a given event.

      -

      Parameters

      • event: string | symbol
      • Rest ...args: any[]

      Returns boolean

    enableRenderPass

    • enableRenderPass(name: string, options?: unknown): void
    • +

      Parameters

      • event: string | symbol
      • Rest ...args: any[]

      Returns boolean

    enableRenderPass

    • enableRenderPass(name: string, options?: unknown): void

    • Enables the render pass with the specified name.

      Parameters

      • name: string

        The name of the render pass to enable.

        @@ -246,7 +246,7 @@

    eventNames

    • eventNames(): (string | symbol)[]

    • Return an array listing the events for which the emitter has registered listeners.

      -

      Returns (string | symbol)[]

    getBoundingBox

    • getBoundingBox(): undefined | AABB

    getBoundingBox

    • getBoundingBox(): undefined | AABB

    • Calculates and returns a axis-aligned bounding box of the mesh in world space.

      Returns undefined | AABB

    getBounds

    • getBounds(skipUpdate?: boolean, rect?: Rectangle): Rectangle

    • Calculates and returns the (world) bounds of the display object as a [Rectangle]{@link PIXI.Rectangle}.

      @@ -304,7 +304,7 @@

    Returns Rectangle

    • The rectangular bounding area.
    -

    isRenderPassEnabled

    • isRenderPassEnabled(name: string): boolean

    isRenderPassEnabled

    • isRenderPassEnabled(name: string): boolean

    • Returns a value indicating if the specified render pass is enabled.

      Parameters

      • name: string

        The name of the render pass to check.

        @@ -340,7 +340,7 @@

      Returns DisplayObject[]

      • List of removed children
      -

    removeInstance

    removeInstance

    updateTransform

    • updateTransform(): void

    • Updates the transform on all children of this container for rendering.

      -

      Returns void

    Static createCube

    Static createCube

    Static createPlane

    Returns Mesh3D

    Static createPlane

    • Creates a new plane (flat square) mesh with the specified material.

      Parameters

      • material: Material = ...

        The material to use.

        -

      Returns Mesh3D

    Static createQuad

    Returns Mesh3D

    Static createQuad

    • Creates a new quad (flat square) mesh with the specified material.

      Parameters

      • material: Material = ...

        The material to use.

        -

      Returns Mesh3D

    Static createSphere

    Returns Mesh3D

    Static createSphere

    destroy

    • destroy(): void

    getShaderGeometry

    getShaderGeometry

    hasShaderGeometry

    • hasShaderGeometry(shader: MeshShader, instanced: boolean): boolean

    Returns Geometry

    hasShaderGeometry

    • hasShaderGeometry(shader: MeshShader, instanced: boolean): boolean

    • Returns a value indicating if geometry with required attributes has been created by the specified shader.

      Parameters

      • shader: MeshShader
        diff --git a/docs/classes/MeshShader.html b/docs/classes/MeshShader.html index 7272560c..f2ff7514 100644 --- a/docs/classes/MeshShader.html +++ b/docs/classes/MeshShader.html @@ -1,4 +1,4 @@ -MeshShader | Pixi3D - v1.6.0
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Class MeshShader

        +MeshShader | Pixi3D - v1.6.1
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Class MeshShader

        Shader used specifically to render a mesh.

        Hierarchy

        • Shader
          • MeshShader

        Index

        Constructors

        Properties

        Accessors

        Methods

        Constructors

        constructor

        • new MeshShader(program: Program, uniforms?: Dict<any>): MeshShader

        • Parameters

          • program: Program

            The program the shader will use.

            @@ -6,17 +6,17 @@

            Custom uniforms to use to augment the built-in ones.

          Returns MeshShader

        Properties

        program

        program: Program

        Program that the shader uses.

        -

        uniformGroup

        uniformGroup: UniformGroup<Dict<any>>

        Accessors

        name

        • get name(): string

        uniformGroup

        uniformGroup: UniformGroup<Dict<any>>

        Accessors

        name

        • get name(): string

        • The name of the mesh shader. Used for figuring out if geometry attributes is compatible with the shader. This needs to be set to something different than default value when custom attributes is used.

          Returns string

        uniforms

        • get uniforms(): Dict<any>

        • Shader uniform values, shortcut for uniformGroup.uniforms.

          -
          readonly

          Returns Dict<any>

        Methods

        checkUniformExists

        • checkUniformExists(name: string, group: UniformGroup<Dict<any>>): boolean

        • Parameters

          • name: string
          • group: UniformGroup<Dict<any>>

          Returns boolean

        createShaderGeometry

        • createShaderGeometry(geometry: MeshGeometry3D, instanced: boolean): Geometry

        Methods

        checkUniformExists

        • checkUniformExists(name: string, group: UniformGroup<Dict<any>>): boolean

        • Parameters

          • name: string
          • group: UniformGroup<Dict<any>>

          Returns boolean

        createShaderGeometry

        • createShaderGeometry(geometry: MeshGeometry3D, instanced: boolean): Geometry

        • Creates geometry with required attributes used by this shader. Override when using custom attributes.

          Parameters

          • geometry: MeshGeometry3D

            The geometry with mesh data.

          • instanced: boolean

            Value indicating if the geometry will be instanced.

            -

          Returns Geometry

        destroy

        • destroy(): void

        • Returns void

        render

        • render(mesh: Mesh3D, renderer: Renderer, state?: State, drawMode?: DRAW_MODES): void

        Returns Geometry

    destroy

    • destroy(): void

    • Returns void

    render

    • render(mesh: Mesh3D, renderer: Renderer, state?: State, drawMode?: DRAW_MODES): void

    localTransform

    mask

    • get mask(): null | Container<DisplayObject> | MaskData
    • set mask(value: null | Container<DisplayObject> | MaskData): void
    • +

      Parameters

      • value: number

      Returns void

    localTransform

    mask

    • get mask(): null | Container<DisplayObject> | MaskData
    • set mask(value: null | Container<DisplayObject> | MaskData): void

    • Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it. In PixiJS a regular mask must be a {@link PIXI.Graphics} or a {@link PIXI.Sprite} object. This allows for much faster masking in canvas as it @@ -125,15 +125,15 @@ is the projection of pivot in the parent's local space.

      By default, the pivot is the origin (0, 0).

      since

      4.0.0

      -

      Parameters

      • value: IPointData

      Returns void

    position

    rotation

    • get rotation(): number
    • set rotation(value: number): void
    • +

      Parameters

      • value: IPointData

      Returns void

    position

    rotation

    • get rotation(): number
    • set rotation(value: number): void

    • The rotation of the object in radians. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.

      Returns number

    • The rotation of the object in radians. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.

      -

      Parameters

      • value: number

      Returns void

    rotationQuaternion

    • +

      Parameters

      • value: number

      Returns void

    rotationQuaternion

    scale

    skew

    • get skew(): ObservablePoint<any>
    • set skew(value: IPointData): void

    scale

    skew

    • get skew(): ObservablePoint<any>
    • set skew(value: IPointData): void

    • The skew factor for the object in radians.

      since

      4.0.0

      Returns ObservablePoint<any>

    • @@ -143,7 +143,7 @@

      The width of the Container, setting this will actually modify the scale to achieve the value set.

      Returns number

    • The width of the Container, setting this will actually modify the scale to achieve the value set.

      -

      Parameters

      • value: number

      Returns void

    worldTransform

    worldVisible

    • get worldVisible(): boolean
    • +

      Parameters

      • value: number

      Returns void

    worldTransform

    worldVisible

    • get worldVisible(): boolean

    • Indicates if the object is globally visible.

      readonly

      Returns boolean

    x

    • get x(): number
    • set x(value: number): void

    • The position of the displayObject on the x axis relative to the local coordinates of the parent. @@ -157,10 +157,10 @@

      Returns number

    • The position of the displayObject on the y axis relative to the local coordinates of the parent. An alias to position.y

      -

      Parameters

      • value: number

      Returns void

    z

    • get z(): number
    • set z(value: number): void
    • +

      Parameters

      • value: number

      Returns void

    z

    • get z(): number
    • set z(value: number): void

    • The position of the object on the z axis relative to the local coordinates of the parent.

      -

      Returns number

    • +

      Returns number

    • The position of the object on the z axis relative to the local coordinates of the parent.

      Parameters

      • value: number

      Returns void

    zIndex

    • get zIndex(): number
    • set zIndex(value: number): void
    • @@ -207,7 +207,7 @@

      Recalculates the bounds of the container.

      This implementation will automatically fit the children's bounds into the calculation. Each child's bounds is limited to its mask's bounds or filterArea, if any is applied.

      -

      Returns void

    createInstance

    createInstance

    destroy

    • destroy(options?: boolean | IDestroyOptions): void

    • Removes all internal references and listeners as well as removes children from the display list. @@ -231,7 +231,7 @@

    eventNames

    • eventNames(): (string | symbol)[]

    • Return an array listing the events for which the emitter has registered listeners.

      -

      Returns (string | symbol)[]

    getBoundingBox

    • getBoundingBox(): AABB

    getBoundingBox

    • getBoundingBox(): AABB

    • Calculates and returns a axis-aligned bounding box of the model in world space. The bounding box will encapsulate the meshes included in the model.

      Returns AABB

    getBounds

    • getBounds(skipUpdate?: boolean, rect?: Rectangle): Rectangle
    • @@ -420,7 +420,7 @@

    updateTransform

    • updateTransform(): void

    • Updates the transform on all children of this container for rendering.

      -

      Returns void

    Static from

    Static from

    • Creates a new model from a source.

      Parameters

      • source: glTFAsset

        The source to create the model from.

        diff --git a/docs/classes/ObservablePoint3D.html b/docs/classes/ObservablePoint3D.html index e983a99d..0cbf67e3 100644 --- a/docs/classes/ObservablePoint3D.html +++ b/docs/classes/ObservablePoint3D.html @@ -1,6 +1,6 @@ -ObservablePoint3D | Pixi3D - v1.6.0
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Class ObservablePoint3D

        +ObservablePoint3D | Pixi3D - v1.6.1
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Class ObservablePoint3D

        Represents a point in 3D space.

        -

        Hierarchy

        • ObservablePoint
          • ObservablePoint3D

        Index

        Constructors

        Properties

        Accessors

        Methods

        Constructors

        constructor

        • new ObservablePoint3D(cb: () => void, scope: any, x?: number, y?: number, z?: number): ObservablePoint3D

        Hierarchy

        • ObservablePoint
          • ObservablePoint3D

        Index

        Constructors

        Properties

        Accessors

        Methods

        Constructors

        constructor

        • new ObservablePoint3D(cb: () => void, scope: any, x?: number, y?: number, z?: number): ObservablePoint3D

        • Creates a new observable point.

          Parameters

          • cb: () => void

            The callback when changed.

            @@ -16,25 +16,25 @@

            The callback function triggered when x and/or y are changed

            Returns any

        scope

        scope: any

        The owner of the callback

        -

    Accessors

    array

    • get array(): Float32Array
    • set array(value: Float32Array): void

    Accessors

    array

    • get array(): Float32Array
    • set array(value: Float32Array): void

    x

    • get x(): number
    • set x(value: number): void

    x

    • get x(): number
    • set x(value: number): void

    y

    • get y(): number
    • set y(value: number): void

    y

    • get y(): number
    • set y(value: number): void

    z

    • get z(): number
    • set z(value: number): void

    z

    • get z(): number
    • set z(value: number): void

    Methods

    clone

    Methods

    clone

    copyFrom

    copyTo

    • copyTo<T>(p: T): T

    equals

    set

  • scope: any = ...

    • Returns ObservablePoint3D

    copyFrom

    copyTo

    • copyTo<T>(p: T): T

    equals

    set

    • Sets the point to a new x, y and z position.

      Parameters

      • x: number

        The position on the x axis.

        @@ -42,7 +42,7 @@

        The position on the y axis.

      • z: number = x

        The position on the z axis.

        -

      Returns ObservablePoint3D

    setFrom

    Returns ObservablePoint3D

    setFrom

    Accessors

    array

    • get array(): Float32Array
    • set array(value: Float32Array): void

    Accessors

    array

    • get array(): Float32Array
    • set array(value: Float32Array): void

    w

    • get w(): number
    • set w(value: number): void

    w

    • get w(): number
    • set w(value: number): void

    x

    • get x(): number
    • set x(value: number): void

    x

    • get x(): number
    • set x(value: number): void

    y

    • get y(): number
    • set y(value: number): void

    y

    • get y(): number
    • set y(value: number): void

    z

    • get z(): number
    • set z(value: number): void

    z

    • get z(): number
    • set z(value: number): void

    Methods

    clone

    Methods

    clone

    • Creates a clone of this quaternion.

      Parameters

      • cb: () => any = ...

        Callback when changed.

        @@ -46,19 +46,19 @@

        The callback function triggered when x and/or y are changed

        Returns any

  • scope: any = ...

    Owner of callback.

    -

    • Returns ObservableQuaternion

    copyFrom

    Returns ObservableQuaternion

    copyFrom

    copyTo

    • copyTo<T>(p: T): T

    Returns ObservableQuaternion

    copyTo

    • copyTo<T>(p: T): T

    • Copies x, y, z and w into the given quaternion.

      Type parameters

      • T: IPoint<T>

      Parameters

      • p: T

        The quaternion to copy to.

        -

      Returns T

    equals

    Returns T

    equals

    set

    Returns boolean

    set

    setEulerAngles

    • setEulerAngles(x: number, y: number, z: number): void

    Returns ObservableQuaternion

    setEulerAngles

    • setEulerAngles(x: number, y: number, z: number): void

    setFrom

    Returns void

    setFrom

    Properties

    Optional camera

    camera?: Camera

    id

    id: Uint8Array = ...

    The id which maps to the object.

    -

    object

    object: Mesh3D | Model

    Methods

    contains

    • contains(x: number, y: number): boolean

    Static fromObject

    object

    object: Mesh3D | Model

    Methods

    contains

    • contains(x: number, y: number): boolean

    Static fromObject

    Properties

    renderer

    renderer: Renderer

    Static main

    main: PickingInteraction

    The main picking interaction which is used by default.

    -

    Methods

    containsHitArea

    • containsHitArea(x: number, y: number, hitArea: PickingHitArea): boolean

    Methods

    containsHitArea

    • containsHitArea(x: number, y: number, hitArea: PickingHitArea): boolean

    destroy

    • destroy(): void

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Inherited constructor
    • Inherited property
    • Inherited accessor
    • Property
    • Method
    • Static property
    • Static method
    • Protected property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns boolean

    destroy

    • destroy(): void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Plane.html b/docs/classes/Plane.html index 61c03f04..59943857 100644 --- a/docs/classes/Plane.html +++ b/docs/classes/Plane.html @@ -1 +1 @@ -Plane | Pixi3D - v1.6.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Plane

    Hierarchy

    • Plane

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    • new Plane(normal: Float32Array, distance: number): Plane

    Properties

    distance

    distance: number

    Accessors

    normal

    • get normal(): Float32Array

    Methods

    rayCast

    • rayCast(ray: Ray): number

    Generated using TypeDoc

    \ No newline at end of file +Plane | Pixi3D - v1.6.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Plane

    Hierarchy

    • Plane

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    • new Plane(normal: Float32Array, distance: number): Plane

    Properties

    distance

    distance: number

    Accessors

    normal

    • get normal(): Float32Array

    Methods

    rayCast

    • rayCast(ray: Ray): number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/PostProcessingSprite.html b/docs/classes/PostProcessingSprite.html index be64c43e..8d9637fe 100644 --- a/docs/classes/PostProcessingSprite.html +++ b/docs/classes/PostProcessingSprite.html @@ -1,7 +1,7 @@ -PostProcessingSprite | Pixi3D - v1.6.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class PostProcessingSprite

    +PostProcessingSprite | Pixi3D - v1.6.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class PostProcessingSprite

    Represents a sprite which can have post processing effects. Can be used for rendering 3D objects as 2D sprites.

    -

    Hierarchy

    • Sprite
      • PostProcessingSprite

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    Hierarchy

    • Sprite
      • PostProcessingSprite

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    • Creates a new post processing sprite using the specified options.

      Parameters

      • renderer: Renderer

        The renderer to use.

        @@ -136,7 +136,7 @@

        Returns number

      • The angle of the object in degrees. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.

        -

        Parameters

        • value: number

        Returns void

    depthTexture

    • get depthTexture(): undefined | BaseTexture<Resource, IAutoDetectOptions>

    depthTexture

    • get depthTexture(): undefined | BaseTexture<Resource, IAutoDetectOptions>

    destroyed

    • get destroyed(): boolean

    • Readonly flag for destroyed display objects.

      @@ -192,7 +192,7 @@

      Returns ObservablePoint<any>

    • The coordinate of the object relative to the local coordinates of the parent.

      since

      4.0.0

      -

      Parameters

      • value: IPointData

      Returns void

    renderTexture

    • get renderTexture(): RenderTexture

    renderTexture

    • get renderTexture(): RenderTexture

    rotation

    • get rotation(): number
    • set rotation(value: number): void

    • The rotation of the object in radians. @@ -313,7 +313,7 @@

      Parameters

      • point: IPointData

        the point to test

      Returns boolean

      The result of the test

      -

    destroy

    • destroy(options?: boolean | IDestroyOptions): void

    disableTempParent

    • disableTempParent(cacheParent: Container<DisplayObject>): void
    • +

    destroy

    • destroy(options?: boolean | IDestroyOptions): void

    disableTempParent

    • disableTempParent(cacheParent: Container<DisplayObject>): void

    • Pair method for enableTempParent

      Parameters

      • cacheParent: Container<DisplayObject>

        Actual parent of element

        @@ -436,7 +436,7 @@

        Render the object using the WebGL renderer and advanced features.

        Parameters

        • renderer: Renderer

          The renderer

          -

        Returns void

    renderObject

    • renderObject(object: DisplayObject): void

    Returns void

    renderObject

    • renderObject(object: DisplayObject): void

    • Updates the sprite's texture by rendering the specified object to it.

      Parameters

      • object: DisplayObject

        The object to render.

        @@ -453,7 +453,7 @@

      Returns Container<DisplayObject>

      • The Container that this DisplayObject was added to.
      -

    setResolution

    • setResolution(resolution: number): void

    setResolution

    • setResolution(resolution: number): void

    Properties

    Optional camera

    camera?: Camera

    The camera to follow when using directional lights.

    -

    followCamera

    followCamera: boolean = true
    +

    followCamera

    followCamera: boolean = true

    Value indicating if the shadow should follow the specified camera. If the camera is not set, the main camera will be used as default. Only available when using directional lights.

    -

    light

    light: Light

    renderer

    renderer: Renderer

    shadowArea

    shadowArea: number = 50
    +

    light

    light: Light

    renderer

    renderer: Renderer

    shadowArea

    shadowArea: number = 50

    The area in units of the shadow when using directional lights. Reducing the area will improve the quality of the shadow.

    -

    softness

    softness: number = 0
    +

    softness

    softness: number = 0

    The softness of the edges for the shadow.

    -

    Accessors

    filterTexture

    • get filterTexture(): RenderTexture

    Accessors

    filterTexture

    • get filterTexture(): RenderTexture

    lightViewProjection

    • get lightViewProjection(): Float32Array

    lightViewProjection

    • get lightViewProjection(): Float32Array

    shadowTexture

    • get shadowTexture(): RenderTexture

    shadowTexture

    • get shadowTexture(): RenderTexture

    Methods

    clear

    • clear(): void

    Methods

    clear

    • clear(): void

    destroy

    • destroy(): void

    destroy

    • destroy(): void

    updateLightViewProjection

    • updateLightViewProjection(): void

    updateLightViewProjection

    • updateLightViewProjection(): void

    Static isHighQualitySupported

    • isHighQualitySupported(renderer: Renderer): boolean

    Static isHighQualitySupported

    • isHighQualitySupported(renderer: Renderer): boolean

    • Returns a value indicating if high quality (32-bit precision) shadows is supported by current platform.

      Parameters

      • renderer: Renderer

        The renderer to use.

        -

      Returns boolean

    Static isMediumQualitySupported

    • isMediumQualitySupported(renderer: Renderer): boolean

    Returns boolean

    Static isMediumQualitySupported

    • isMediumQualitySupported(renderer: Renderer): boolean

    clear

    • clear(): void

    removeShadowCastingLight

    removeShadowCastingLight

    render

    • render(meshes: Mesh3D[]): void

    Returns void

    render

    • render(meshes: Mesh3D[]): void

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Inherited constructor
    • Inherited property
    • Inherited accessor
    • Property
    • Method
    • Static property
    • Static method
    • Protected property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Skin.html b/docs/classes/Skin.html index 99653f50..33c7fb83 100644 --- a/docs/classes/Skin.html +++ b/docs/classes/Skin.html @@ -1,15 +1,15 @@ -Skin | Pixi3D - v1.6.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Skin

    +Skin | Pixi3D - v1.6.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Skin

    Represents a skin used for vertex skinning.

    -

    Hierarchy

    • Skin

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    Hierarchy

    • Skin

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    Properties

    jointMatrices

    jointMatrices: Float32Array = ...
    +

    Returns Skin

    Properties

    jointMatrices

    jointMatrices: Float32Array = ...

    The joint matrices which has been calculated.

    -

    jointNormalMatrices

    jointNormalMatrices: Float32Array = ...
    +

    jointNormalMatrices

    jointNormalMatrices: Float32Array = ...

    The joint normal matrices which has been calculated.

    -

    Readonly joints

    joints: Joint[]

    Readonly parent

    parent: Container3D

    Methods

    calculateJointMatrices

    • calculateJointMatrices(): void

    Readonly joints

    joints: Joint[]

    Readonly parent

    parent: Container3D

    Methods

    calculateJointMatrices

    • calculateJointMatrices(): void

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Inherited constructor
    • Inherited property
    • Inherited accessor
    • Property
    • Method
    • Static property
    • Static method
    • Protected property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Skybox.html b/docs/classes/Skybox.html index b1b7059b..12bc58a6 100644 --- a/docs/classes/Skybox.html +++ b/docs/classes/Skybox.html @@ -1,8 +1,8 @@ -Skybox | Pixi3D - v1.6.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Skybox

    +Skybox | Pixi3D - v1.6.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Skybox

    A skybox is a method of creating backgrounds in a 3D scene. It consists of a cubemap texture which has six sides. Note that the skybox should be rendered before all other objects in the scene.

    -

    Hierarchy

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    Hierarchy

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    • Creates a new skybox using the specified cubemap.

      Parameters

      • cubemap: Cubemap

        Cubemap to use for rendering.

        @@ -67,7 +67,7 @@

        Also be aware of that this may not work nicely with the addChildAt() function, as the zIndex sorting may cause the child to automatically sorted to another position.

        see

        PIXI.settings.SORTABLE_CHILDREN

        -

    trackedPointers

    trackedPointers: {}

    Type declaration

    • [x: number]: InteractionTrackingData

    transform

    transform: Transform3D = ...

    visible

    visible: boolean
    +

    trackedPointers

    trackedPointers: {}

    Type declaration

    • [x: number]: InteractionTrackingData

    transform

    transform: Transform3D = ...

    visible

    visible: boolean

    The visibility of the object. If false the object will not be drawn, and the updateTransform function will not be called.

    Only affects recursive calls from parent. You can ask for bounds or call updateTransform manually.

    @@ -80,15 +80,15 @@

    Returns number

  • The angle of the object in degrees. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.

    -

    Parameters

    • value: number

    Returns void

    • camera

    • get camera(): undefined | Camera
    • set camera(value: undefined | Camera): void

    camera

    • get camera(): undefined | Camera
    • set camera(value: undefined | Camera): void

    cubemap

    cubemap

    destroyed

    • get destroyed(): boolean

    • Readonly flag for destroyed display objects.

      @@ -96,7 +96,7 @@

      The height of the Container, setting this will actually modify the scale to achieve the value set.

      Returns number

    • The height of the Container, setting this will actually modify the scale to achieve the value set.

      -

      Parameters

      • value: number

      Returns void

    localTransform

    mask

    • get mask(): null | Container<DisplayObject> | MaskData
    • set mask(value: null | Container<DisplayObject> | MaskData): void
    • +

      Parameters

      • value: number

      Returns void

    localTransform

    mask

    • get mask(): null | Container<DisplayObject> | MaskData
    • set mask(value: null | Container<DisplayObject> | MaskData): void

    • Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it. In PixiJS a regular mask must be a {@link PIXI.Graphics} or a {@link PIXI.Sprite} object. This allows for much faster masking in canvas as it @@ -136,15 +136,15 @@ is the projection of pivot in the parent's local space.

      By default, the pivot is the origin (0, 0).

      since

      4.0.0

      -

      Parameters

      • value: IPointData

      Returns void

    position

    rotation

    • get rotation(): number
    • set rotation(value: number): void
    • +

      Parameters

      • value: IPointData

      Returns void

    position

    rotation

    • get rotation(): number
    • set rotation(value: number): void

    • The rotation of the object in radians. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.

      Returns number

    • The rotation of the object in radians. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.

      -

      Parameters

      • value: number

      Returns void

    rotationQuaternion

    • +

      Parameters

      • value: number

      Returns void

    rotationQuaternion

    scale

    skew

    • get skew(): ObservablePoint<any>
    • set skew(value: IPointData): void

    scale

    skew

    • get skew(): ObservablePoint<any>
    • set skew(value: IPointData): void

    • The skew factor for the object in radians.

      since

      4.0.0

      Returns ObservablePoint<any>

    • @@ -154,7 +154,7 @@

      The width of the Container, setting this will actually modify the scale to achieve the value set.

      Returns number

    • The width of the Container, setting this will actually modify the scale to achieve the value set.

      -

      Parameters

      • value: number

      Returns void

    worldTransform

    worldVisible

    • get worldVisible(): boolean
    • +

      Parameters

      • value: number

      Returns void

    worldTransform

    worldVisible

    • get worldVisible(): boolean

    • Indicates if the object is globally visible.

      readonly

      Returns boolean

    x

    • get x(): number
    • set x(value: number): void

    • The position of the displayObject on the x axis relative to the local coordinates of the parent. @@ -168,10 +168,10 @@

      Returns number

    • The position of the displayObject on the y axis relative to the local coordinates of the parent. An alias to position.y

      -

      Parameters

      • value: number

      Returns void

    z

    • get z(): number
    • set z(value: number): void
    • +

      Parameters

      • value: number

      Returns void

    z

    • get z(): number
    • set z(value: number): void

    • The position of the object on the z axis relative to the local coordinates of the parent.

      -

      Returns number

    • +

      Returns number

    • The position of the object on the z axis relative to the local coordinates of the parent.

      Parameters

      • value: number

      Returns void

    zIndex

    • get zIndex(): number
    • set zIndex(value: number): void
    • @@ -426,7 +426,7 @@

    updateTransform

    • updateTransform(): void

    • Updates the transform on all children of this container for rendering.

      -

      Returns void

    Static from

    Static from

    enableShadows

    • Enables shadows for the specified object. Adds the shadow render pass to the specified object and enables the standard material to use the casting light.

      @@ -31,13 +31,13 @@
    • Optional light: ShadowCastingLight

      The shadow casting light to associate with the object when using the standard material.

      -

    Returns void

    flush

    • flush(): void

    Returns void

    flush

    • flush(): void

    render

    • render(object: Mesh3D | ProjectionSprite): void

    render

    • render(object: Mesh3D | ProjectionSprite): void

    sort

    • sort(): void

    Returns void

    sort

    • sort(): void

    start

    • start(): void

    toString

    • toString(): string

    • Returns string

    updateLocalTransform

    • updateLocalTransform(): void

    Protected updateSkew

    • updateSkew(): void

    • Called when the skew or the rotation changes.

      -

      Returns void

    updateTransform

    • updateTransform(parentTransform?: Transform): void

    updateTransform

    • updateTransform(parentTransform?: Transform): void

    • Updates the world transformation matrix.

      Parameters

      • Optional parentTransform: Transform

        The parent transform.

        diff --git a/docs/classes/Vec3.html b/docs/classes/Vec3.html index 84da1ca2..61dad982 100644 --- a/docs/classes/Vec3.html +++ b/docs/classes/Vec3.html @@ -1 +1 @@ -Vec3 | Pixi3D - v1.6.0
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Class Vec3

        Hierarchy

        • Vec3

        Index

        Constructors

        Methods

        Constructors

        constructor

        Methods

        Static add

        • add(a: Float32Array, b: Float32Array, out?: Float32Array): Float32Array

        • Parameters

          • a: Float32Array
          • b: Float32Array
          • out: Float32Array = ...

          Returns Float32Array

        Static copy

        • copy(a: Float32Array, out?: Float32Array): Float32Array

        • Parameters

          • a: Float32Array
          • out: Float32Array = ...

          Returns Float32Array

        Static create

        • create(): Float32Array

        Static cross

        • cross(a: Float32Array, b: Float32Array, out?: Float32Array): Float32Array

        • Parameters

          • a: Float32Array
          • b: Float32Array
          • out: Float32Array = ...

          Returns Float32Array

        Static distance

        • distance(a: Float32Array, b: Float32Array): number

        Static dot

        • dot(a: Float32Array, b: Float32Array): number

        Static fromValues

        • fromValues(x: number, y: number, z: number): Float32Array

        Static inverse

        • inverse(a: Float32Array, out?: Float32Array): Float32Array

        • Parameters

          • a: Float32Array
          • out: Float32Array = ...

          Returns Float32Array

        Static lerp

        • lerp(a: Float32Array, b: Float32Array, t: number, out?: Float32Array): vec3

        • Parameters

          • a: Float32Array
          • b: Float32Array
          • t: number
          • out: Float32Array = ...

          Returns vec3

        Static magnitude

        • magnitude(a: Float32Array): number

        Static multiply

        • multiply(a: Float32Array, b: Float32Array, out?: Float32Array): Float32Array

        • Parameters

          • a: Float32Array
          • b: Float32Array
          • out: Float32Array = ...

          Returns Float32Array

        Static negate

        • negate(a: Float32Array, out?: Float32Array): Float32Array

        • Parameters

          • a: Float32Array
          • out: Float32Array = ...

          Returns Float32Array

        Static normalize

        • normalize(a: Float32Array, out?: Float32Array): Float32Array

        • Parameters

          • a: Float32Array
          • out: Float32Array = ...

          Returns Float32Array

        Static scale

        • scale(a: Float32Array, b: number, out?: Float32Array): Float32Array

        • Parameters

          • a: Float32Array
          • b: number
          • out: Float32Array = ...

          Returns Float32Array

        Static set

        • set(x: number, y: number, z: number, out?: Float32Array): Float32Array

        • Parameters

          • x: number
          • y: number
          • z: number
          • out: Float32Array = ...

          Returns Float32Array

        Static squaredDistance

        • squaredDistance(a: Float32Array, b: Float32Array): number

        Static squaredMagnitude

        • squaredMagnitude(a: Float32Array): number

        Static subtract

        • subtract(a: Float32Array, b: Float32Array, out?: Float32Array): Float32Array

        • Parameters

          • a: Float32Array
          • b: Float32Array
          • out: Float32Array = ...

          Returns Float32Array

        Static transformMat4

        • transformMat4(a: Float32Array, m: Float32Array, out?: Float32Array): Float32Array

        • Parameters

          • a: Float32Array
          • m: Float32Array
          • out: Float32Array = ...

          Returns Float32Array

        Static transformQuat

        • transformQuat(a: Float32Array, q: Float32Array, out?: Float32Array): Float32Array

        • Parameters

          • a: Float32Array
          • q: Float32Array
          • out: Float32Array = ...

          Returns Float32Array

        Legend

        • Constructor
        • Property
        • Method
        • Accessor
        • Inherited constructor
        • Inherited property
        • Inherited accessor
        • Property
        • Method
        • Static property
        • Static method
        • Protected property

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file +Vec3 | Pixi3D - v1.6.1
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Class Vec3

        Hierarchy

        • Vec3

        Index

        Constructors

        Methods

        Constructors

        constructor

        Methods

        Static add

        • add(a: Float32Array, b: Float32Array, out?: Float32Array): Float32Array

        • Parameters

          • a: Float32Array
          • b: Float32Array
          • out: Float32Array = ...

          Returns Float32Array

        Static copy

        • copy(a: Float32Array, out?: Float32Array): Float32Array

        • Parameters

          • a: Float32Array
          • out: Float32Array = ...

          Returns Float32Array

        Static create

        • create(): Float32Array

        Static cross

        • cross(a: Float32Array, b: Float32Array, out?: Float32Array): Float32Array

        • Parameters

          • a: Float32Array
          • b: Float32Array
          • out: Float32Array = ...

          Returns Float32Array

        Static distance

        • distance(a: Float32Array, b: Float32Array): number

        Static dot

        • dot(a: Float32Array, b: Float32Array): number

        Static fromValues

        • fromValues(x: number, y: number, z: number): Float32Array

        Static inverse

        • inverse(a: Float32Array, out?: Float32Array): Float32Array

        • Parameters

          • a: Float32Array
          • out: Float32Array = ...

          Returns Float32Array

        Static lerp

        • lerp(a: Float32Array, b: Float32Array, t: number, out?: Float32Array): vec3

        • Parameters

          • a: Float32Array
          • b: Float32Array
          • t: number
          • out: Float32Array = ...

          Returns vec3

        Static magnitude

        • magnitude(a: Float32Array): number

        Static multiply

        • multiply(a: Float32Array, b: Float32Array, out?: Float32Array): Float32Array

        • Parameters

          • a: Float32Array
          • b: Float32Array
          • out: Float32Array = ...

          Returns Float32Array

        Static negate

        • negate(a: Float32Array, out?: Float32Array): Float32Array

        • Parameters

          • a: Float32Array
          • out: Float32Array = ...

          Returns Float32Array

        Static normalize

        • normalize(a: Float32Array, out?: Float32Array): Float32Array

        • Parameters

          • a: Float32Array
          • out: Float32Array = ...

          Returns Float32Array

        Static scale

        • scale(a: Float32Array, b: number, out?: Float32Array): Float32Array

        • Parameters

          • a: Float32Array
          • b: number
          • out: Float32Array = ...

          Returns Float32Array

        Static set

        • set(x: number, y: number, z: number, out?: Float32Array): Float32Array

        • Parameters

          • x: number
          • y: number
          • z: number
          • out: Float32Array = ...

          Returns Float32Array

        Static squaredDistance

        • squaredDistance(a: Float32Array, b: Float32Array): number

        Static squaredMagnitude

        • squaredMagnitude(a: Float32Array): number

        Static subtract

        • subtract(a: Float32Array, b: Float32Array, out?: Float32Array): Float32Array

        • Parameters

          • a: Float32Array
          • b: Float32Array
          • out: Float32Array = ...

          Returns Float32Array

        Static transformMat4

        • transformMat4(a: Float32Array, m: Float32Array, out?: Float32Array): Float32Array

        • Parameters

          • a: Float32Array
          • m: Float32Array
          • out: Float32Array = ...

          Returns Float32Array

        Static transformQuat

        • transformQuat(a: Float32Array, q: Float32Array, out?: Float32Array): Float32Array

        • Parameters

          • a: Float32Array
          • q: Float32Array
          • out: Float32Array = ...

          Returns Float32Array

        Legend

        • Constructor
        • Property
        • Method
        • Accessor
        • Inherited constructor
        • Inherited property
        • Inherited accessor
        • Property
        • Method
        • Static property
        • Static method
        • Protected property

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/classes/glTFAsset.html b/docs/classes/glTFAsset.html index ce0dd3ec..35026b76 100644 --- a/docs/classes/glTFAsset.html +++ b/docs/classes/glTFAsset.html @@ -1,6 +1,6 @@ -glTFAsset | Pixi3D - v1.6.0
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Class glTFAsset

        +glTFAsset | Pixi3D - v1.6.1
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Class glTFAsset

        glTF assets are JSON files plus supporting external data.

        -

        Hierarchy

        • glTFAsset

        Index

        Constructors

        Properties

        Methods

        Constructors

        constructor

        • new glTFAsset(descriptor: any, buffers?: ArrayBuffer[], images?: Texture<Resource>[]): glTFAsset

        Hierarchy

        • glTFAsset

        Index

        Constructors

        Properties

        Methods

        Constructors

        constructor

        • new glTFAsset(descriptor: any, buffers?: ArrayBuffer[], images?: Texture<Resource>[]): glTFAsset

        • Creates a new glTF asset using the specified JSON descriptor.

          Parameters

          • descriptor: any

            The JSON descriptor to create the asset from.

            @@ -8,22 +8,22 @@

            The buffers used by this asset.

          • images: Texture<Resource>[] = []

            The images used by this asset.

            -

          Returns glTFAsset

        Properties

        Readonly buffers

        buffers: ArrayBuffer[] = []

        Readonly descriptor

        descriptor: any

        Readonly images

        images: Texture<Resource>[] = []

        Methods

        Static fromBuffer

        • fromBuffer(data: ArrayBuffer, cb: (gltf: glTFAsset) => void): void

        Returns glTFAsset

    Properties

    Readonly buffers

    buffers: ArrayBuffer[] = []

    Readonly descriptor

    descriptor: any

    Readonly images

    images: Texture<Resource>[] = []

    Methods

    Static fromBuffer

    • fromBuffer(data: ArrayBuffer, cb: (gltf: glTFAsset) => void): void

    • Creates a new glTF asset from binary (glb) buffer data.

      Parameters

      • data: ArrayBuffer

        The binary buffer data to read from.

      • cb: (gltf: glTFAsset) => void

        The function which gets called when the asset has been created.

        -

      Returns void

    Static isEmbeddedResource

    • isEmbeddedResource(uri: string): boolean

    Returns void

    Static isEmbeddedResource

    • isEmbeddedResource(uri: string): boolean | ""

    • Returns a value indicating if the specified uri is embedded.

      Parameters

      • uri: string

        The uri to check.

        -

      Returns boolean

    Static isValidBuffer

    • isValidBuffer(buffer: ArrayBuffer): boolean

    Returns boolean | ""

    Static isValidBuffer

    • isValidBuffer(buffer: ArrayBuffer): boolean

    • Returns a value indicating if the specified data buffer is a valid glTF.

      Parameters

      • buffer: ArrayBuffer

        The buffer data to validate.

        -

      Returns boolean

    Static load

    Returns boolean

    Static load

    • Loads a new glTF asset (including resources) using the specified JSON descriptor.

      Parameters

      • descriptor: any
        @@ -31,4 +31,6 @@
      • Optional loader: glTFResourceLoader

        The resource loader to use for external resources. The loader can be empty when all resources in the descriptor is embedded.

        -

      Returns glTFAsset

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Inherited constructor
    • Inherited property
    • Inherited accessor
    • Property
    • Method
    • Static property
    • Static method
    • Protected property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +
  • Optional cb: (asset: glTFAsset) => void
    +

    Callback when all resources have been loaded.

    +

    • Returns glTFAsset

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/enums/LightType.html b/docs/enums/LightType.html index 72f2f03b..a21b483d 100644 --- a/docs/enums/LightType.html +++ b/docs/enums/LightType.html @@ -1,9 +1,9 @@ -LightType | Pixi3D - v1.6.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Enumeration LightType

    Index

    Enumeration members

    Enumeration members

    directional

    directional = "directional"
    +LightType | Pixi3D - v1.6.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Enumeration LightType

    Index

    Enumeration members

    Enumeration members

    directional

    directional = "directional"

    A light that is located infinitely far away, and emits light in one direction only.

    -

    point

    point = "point"
    +

    point

    point = "point"

    A light that is located at a point and emits light in all directions equally.

    -

    spot

    spot = "spot"
    +

    spot

    spot = "spot"

    A light that is located at a point and emits light in a cone shape.

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Inherited constructor
    • Inherited property
    • Inherited accessor
    • Property
    • Method
    • Static property
    • Static method
    • Protected property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/enums/MaterialRenderSortType.html b/docs/enums/MaterialRenderSortType.html index 74bde9fa..cbd0312d 100644 --- a/docs/enums/MaterialRenderSortType.html +++ b/docs/enums/MaterialRenderSortType.html @@ -1 +1 @@ -MaterialRenderSortType | Pixi3D - v1.6.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Enumeration MaterialRenderSortType

    Index

    Enumeration members

    Enumeration members

    opaque

    opaque = "opaque"

    transparent

    transparent = "transparent"

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Inherited constructor
    • Inherited property
    • Inherited accessor
    • Property
    • Method
    • Static property
    • Static method
    • Protected property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +MaterialRenderSortType | Pixi3D - v1.6.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Enumeration MaterialRenderSortType

    Index

    Enumeration members

    Enumeration members

    opaque

    opaque = "opaque"

    transparent

    transparent = "transparent"

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Inherited constructor
    • Inherited property
    • Inherited accessor
    • Property
    • Method
    • Static property
    • Static method
    • Protected property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/enums/ShadowQuality.html b/docs/enums/ShadowQuality.html index d7085d68..b1e1215d 100644 --- a/docs/enums/ShadowQuality.html +++ b/docs/enums/ShadowQuality.html @@ -1,7 +1,7 @@ -ShadowQuality | Pixi3D - v1.6.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Enumeration ShadowQuality

    Index

    Enumeration members

    Enumeration members

    high

    high = "high"
    +ShadowQuality | Pixi3D - v1.6.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Enumeration ShadowQuality

    Index

    Enumeration members

    Enumeration members

    high

    high = "high"

    High quality (32-bit) shadows.

    -

    low

    low = "low"
    +

    low

    low = "low"

    Low quality (8-bit) shadows.

    -

    medium

    medium = "medium"
    +

    medium

    medium = "medium"

    Medium quality (16-bit) shadows.

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Inherited constructor
    • Inherited property
    • Inherited accessor
    • Property
    • Method
    • Static property
    • Static method
    • Protected property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/enums/SpriteBillboardType.html b/docs/enums/SpriteBillboardType.html index 0e46a871..92f6f892 100644 --- a/docs/enums/SpriteBillboardType.html +++ b/docs/enums/SpriteBillboardType.html @@ -1,7 +1,7 @@ -SpriteBillboardType | Pixi3D - v1.6.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Enumeration SpriteBillboardType

    +SpriteBillboardType | Pixi3D - v1.6.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Enumeration SpriteBillboardType

    Represents different billboard types.

    -

    Index

    Enumeration members

    Enumeration members

    cylindrical

    cylindrical = "cylindrical"
    +

    Index

    Enumeration members

    Enumeration members

    cylindrical

    cylindrical = "cylindrical"

    Sprite will be rotated towards the viewer on the y-plane.

    -

    spherical

    spherical = "spherical"
    +

    spherical

    spherical = "spherical"

    Sprite will be rotated towards the viewer on both the x-plane and y-plane.

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Inherited constructor
    • Inherited property
    • Inherited accessor
    • Property
    • Method
    • Static property
    • Static method
    • Protected property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/enums/StandardMaterialAlphaMode.html b/docs/enums/StandardMaterialAlphaMode.html index 894fcee5..604213ed 100644 --- a/docs/enums/StandardMaterialAlphaMode.html +++ b/docs/enums/StandardMaterialAlphaMode.html @@ -1,11 +1,11 @@ -StandardMaterialAlphaMode | Pixi3D - v1.6.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Enumeration StandardMaterialAlphaMode

    Index

    Enumeration members

    Enumeration members

    blend

    blend = "blend"
    +StandardMaterialAlphaMode | Pixi3D - v1.6.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Enumeration StandardMaterialAlphaMode

    Index

    Enumeration members

    Enumeration members

    blend

    blend = "blend"

    The rendered output is combined with the background using the normal painting operation (i.e. the Porter and Duff over operator). This mode is used to simulate geometry such as guaze cloth or animal fur.

    -

    mask

    mask = "mask"
    +

    mask

    mask = "mask"

    The rendered output is either fully opaque or fully transparent depending on the alpha value and the specified alpha cutoff value. This mode is used to simulate geometry such as tree leaves or wire fences.

    -

    opaque

    opaque = "opaque"
    +

    opaque

    opaque = "opaque"

    The rendered output is fully opaque and any alpha value is ignored.

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Inherited constructor
    • Inherited property
    • Inherited accessor
    • Property
    • Method
    • Static property
    • Static method
    • Protected property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/enums/StandardMaterialDebugMode.html b/docs/enums/StandardMaterialDebugMode.html index ef9f72fe..40c522e9 100644 --- a/docs/enums/StandardMaterialDebugMode.html +++ b/docs/enums/StandardMaterialDebugMode.html @@ -1 +1 @@ -StandardMaterialDebugMode | Pixi3D - v1.6.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Enumeration StandardMaterialDebugMode

    Index

    Enumeration members

    Enumeration members

    alpha

    alpha = "alpha"

    emissive

    emissive = "emissive"

    f0

    f0 = "f0"

    metallic

    metallic = "metallic"

    normal

    normal = "normal"

    occlusion

    occlusion = "occlusion"

    roughness

    roughness = "roughness"

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Inherited constructor
    • Inherited property
    • Inherited accessor
    • Property
    • Method
    • Static property
    • Static method
    • Protected property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +StandardMaterialDebugMode | Pixi3D - v1.6.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Enumeration StandardMaterialDebugMode

    Index

    Enumeration members

    Enumeration members

    alpha

    alpha = "alpha"

    emissive

    emissive = "emissive"

    f0

    f0 = "f0"

    metallic

    metallic = "metallic"

    normal

    normal = "normal"

    occlusion

    occlusion = "occlusion"

    roughness

    roughness = "roughness"

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Inherited constructor
    • Inherited property
    • Inherited accessor
    • Property
    • Method
    • Static property
    • Static method
    • Protected property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 291f8358..c8a9d3c5 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,4 @@ -Pixi3D - v1.6.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Pixi3D - v1.6.0

    +Pixi3D - v1.6.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Pixi3D - v1.6.1

    Pixi3D

     diff --git a/docs/interfaces/CubemapFaces.html b/docs/interfaces/CubemapFaces.html index 7d9d806a..38a67227 100644 --- a/docs/interfaces/CubemapFaces.html +++ b/docs/interfaces/CubemapFaces.html @@ -1,13 +1,13 @@ -CubemapFaces | Pixi3D - v1.6.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CubemapFaces

    Hierarchy

    • CubemapFaces

    Index

    Properties

    Properties

    negx

    negx: string | Texture<Resource>
    +CubemapFaces | Pixi3D - v1.6.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CubemapFaces

    Hierarchy

    • CubemapFaces

    Index

    Properties

    Properties

    negx

    negx: string | Texture<Resource>

    The texture or url for negative x.

    -

    negy

    negy: string | Texture<Resource>
    +

    negy

    negy: string | Texture<Resource>

    The texture or url for negative y.

    -

    negz

    negz: string | Texture<Resource>
    +

    negz

    negz: string | Texture<Resource>

    The texture or url for negative z.

    -

    posx

    posx: string | Texture<Resource>
    +

    posx

    posx: string | Texture<Resource>

    The texture or url for positive x.

    -

    posy

    posy: string | Texture<Resource>
    +

    posy

    posy: string | Texture<Resource>

    The texture or url for positive y.

    -

    posz

    posz: string | Texture<Resource>
    +

    posz

    posz: string | Texture<Resource>

    The texture or url for positive z.

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Inherited constructor
    • Inherited property
    • Inherited accessor
    • Property
    • Method
    • Static property
    • Static method
    • Protected property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/MaterialFactory.html b/docs/interfaces/MaterialFactory.html index 7ae5e393..636b9a51 100644 --- a/docs/interfaces/MaterialFactory.html +++ b/docs/interfaces/MaterialFactory.html @@ -1,6 +1,6 @@ -MaterialFactory | Pixi3D - v1.6.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface MaterialFactory

    +MaterialFactory | Pixi3D - v1.6.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface MaterialFactory

    Factory for creating materials.

    -

    Hierarchy

    • MaterialFactory

    Index

    Methods

    Methods

    create

    Hierarchy

    • MaterialFactory

    Index

    Methods

    Methods

    create