From fde244fc4054aeee4ad2c616ed4aea7e827785ab Mon Sep 17 00:00:00 2001 From: Jens Malmborg Date: Wed, 29 Mar 2023 22:36:11 +0200 Subject: [PATCH] 2.3.1 --- docs/classes/AABB.html | 20 ++--- docs/classes/Animation.html | 18 ++-- docs/classes/Camera.html | 62 ++++++------- docs/classes/CameraOrbitControl.html | 36 ++++---- docs/classes/Color.html | 30 +++---- docs/classes/CompositeSprite.html | 12 +-- docs/classes/Container3D.html | 18 ++-- docs/classes/Cubemap.html | 12 +-- 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/Matrix4x4.html | 70 +++++++-------- docs/classes/Mesh3D.html | 60 ++++++------- docs/classes/MeshGeometry3D.html | 10 +-- docs/classes/MeshShader.html | 8 +- docs/classes/Model.html | 28 +++--- docs/classes/PickingHitArea.html | 8 +- docs/classes/PickingInteraction.html | 10 +-- docs/classes/Plane.html | 2 +- docs/classes/Point3D.html | 54 +++++------ docs/classes/Quat.html | 2 +- docs/classes/Quaternion.html | 52 +++++------ docs/classes/Ray.html | 2 +- docs/classes/ShadowCastingLight.html | 28 +++--- docs/classes/ShadowRenderPass.html | 12 +-- docs/classes/Skin.html | 10 +-- docs/classes/Skybox.html | 34 +++---- docs/classes/Sprite3D.html | 52 +++++------ 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 | 20 ++--- docs/classes/TextureTransform.html | 14 +-- docs/classes/Transform3D.html | 24 ++--- docs/classes/Vec3.html | 2 +- docs/classes/glTFAsset.html | 14 +-- docs/enums/CubemapFormat.html | 4 +- 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/CompositeSpriteOptions.html | 8 +- docs/interfaces/CubemapFaces.html | 12 +-- docs/interfaces/MaterialFactory.html | 4 +- docs/interfaces/MeshDestroyOptions.html | 2 +- docs/interfaces/MeshGeometryAttribute.html | 14 +-- docs/interfaces/MeshGeometryTarget.html | 4 +- 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 +- 68 files changed, 562 insertions(+), 562 deletions(-) diff --git a/docs/classes/AABB.html b/docs/classes/AABB.html index ef46c24..13cf52e 100644 --- a/docs/classes/AABB.html +++ b/docs/classes/AABB.html @@ -1,24 +1,24 @@ -AABB | Pixi3D - v2.3.0
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AABB

+AABB | Pixi3D - v2.3.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

  • screenToWorld(x: number, y: number, distance: number, point?: Point3D, viewSize?: { height: number; width: number }): undefined | Point3D

Returns undefined | Ray

screenToWorld

  • screenToWorld(x: number, y: number, distance: number, point?: Point3D, viewSize?: { height: number; width: number }): undefined | Point3D

  • 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

Protected _allowControl

_allowControl: boolean = true

Protected _angles

_angles: ObservablePoint<undefined> = ...

Protected _autoUpdate

_autoUpdate: boolean = true

Protected _camera

_camera: Camera = Camera.main

Protected _dampingAngles

_dampingAngles: { x: number; y: number } = ...

Type declaration

  • x: number
  • y: number

Protected _dampingDistance

_dampingDistance: number = 5

Protected _dampingFactor

_dampingFactor: number = 0.1

Protected _distance

_distance: number = 5

Protected _element

_element: HTMLElement

Protected _enableDamping

_enableDamping: boolean = false

Protected _grabbed

_grabbed: boolean = false

Protected _previousClientX

_previousClientX: number = 0

Protected _previousClientY

_previousClientY: number = 0

Protected _previousPinchDistance

_previousPinchDistance: number = 0

Protected _target

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

Type declaration

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

Accessors

allowControl

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

angles

  • get angles(): ObservablePoint<undefined>

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>

autoUpdate

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

autoUpdate

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

camera

camera

dampingFactor

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

dampingFactor

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

distance

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

distance

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

enableDamping

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

enableDamping

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

target

  • get target(): { x: number; y: number; z: number }
  • set target(value: { x: number; y: number; z: number }): void

target

  • get target(): { x: number; y: number; z: number }
  • set target(value: { x: number; y: number; z: number }): void

Methods

Protected bind

  • bind(): void

destroy

  • destroy(): void

Protected onMouseDown

  • onMouseDown(e: MouseEvent): void

Protected onMouseDownInteraction

  • onMouseDownInteraction(e: InteractionEvent): void

Protected onMouseMove

  • onMouseMove(e: MouseEvent): void

Protected onMouseUp

  • onMouseUp(_e: MouseEvent): void

Protected onPinch

  • onPinch(e: TouchEvent): void

Protected onPointerDown

  • onPointerDown(clientX: number, clientY: number): void

Protected onPointerMove

  • onPointerMove(clientX: number, clientY: number): void

Protected onPointerUp

  • onPointerUp(): void

Protected onPreRender

  • onPreRender(): void

Protected onTouchEnd

  • onTouchEnd(e: TouchEvent): void

Protected onTouchMove

  • onTouchMove(e: TouchEvent): void

Protected onTouchStart

  • onTouchStart(e: TouchEvent): void

Protected onWheel

  • onWheel(e: WheelEvent): void

Protected unbind

  • unbind(): void

updateCamera

  • updateCamera(): void

Methods

Protected bind

  • bind(): void

destroy

  • destroy(): void

Protected onMouseDown

  • onMouseDown(e: MouseEvent): void

Protected onMouseDownInteraction

  • onMouseDownInteraction(e: InteractionEvent): void

Protected onMouseMove

  • onMouseMove(e: MouseEvent): void

Protected onMouseUp

  • onMouseUp(_e: MouseEvent): void

Protected onPinch

  • onPinch(e: TouchEvent): void

Protected onPointerDown

  • onPointerDown(clientX: number, clientY: number): void

Protected onPointerMove

  • onPointerMove(clientX: number, clientY: number): void

Protected onPointerUp

  • onPointerUp(): void

Protected onPreRender

  • onPreRender(): void

Protected onTouchEnd

  • onTouchEnd(e: TouchEvent): void

Protected onTouchMove

  • onTouchMove(e: TouchEvent): void

Protected onTouchStart

  • onTouchStart(e: TouchEvent): void

Protected onWheel

  • onWheel(e: WheelEvent): void

Protected unbind

  • unbind(): void

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 14c2385..c89c5b8 100644 --- a/docs/classes/Color.html +++ b/docs/classes/Color.html @@ -1,6 +1,6 @@ -Color | Pixi3D - v2.3.0
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Color

+Color | Pixi3D - v2.3.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

renderObject

  • renderObject(object: DisplayObject): void

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

    Parameters

    • object: DisplayObject

      The object to render.

      @@ -451,7 +451,7 @@

    Returns Container<DisplayObject>

    • The Container that this DisplayObject was added to.
    -

setResolution

  • setResolution(resolution: number): void

setResolution

  • setResolution(resolution: 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 @@ -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 71f7005..6a2d59c 100644 --- a/docs/classes/Cubemap.html +++ b/docs/classes/Cubemap.html @@ -1,4 +1,4 @@ -Cubemap | Pixi3D - v2.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Cubemap

    +Cubemap | Pixi3D - v2.3.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

        @@ -19,7 +19,7 @@

    cacheId

    cacheId: string

    Currently default cache ID.

    member

    {string}

    -

    cubemapFormat

    cubemapFormat: CubemapFormat = CubemapFormat.ldr
    +

    cubemapFormat

    cubemapFormat: CubemapFormat = CubemapFormat.ldr

    The format for this cubemap.

    destroyed

    destroyed: boolean

    Flag if BaseTexture has been destroyed.

    @@ -70,7 +70,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

      @@ -94,7 +94,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.

      @@ -204,7 +204,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.

      @@ -218,7 +218,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
  • Protected property
  • Protected method
  • Static property
  • Static method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/InstancedMesh3D.html b/docs/classes/InstancedMesh3D.html index 93c23c7..0e55e6a 100644 --- a/docs/classes/InstancedMesh3D.html +++ b/docs/classes/InstancedMesh3D.html @@ -1,4 +1,4 @@ -InstancedMesh3D | Pixi3D - v2.3.0
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class InstancedMesh3D

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

_bounds

_bounds: Bounds
+InstancedMesh3D | Pixi3D - v2.3.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
    • +

      Returns Quaternion

    • Parameters

      Returns 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
    • +

      Returns Quaternion

    • Parameters

      Returns 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
    • Protected property
    • Protected method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Joint.html b/docs/classes/Joint.html index 7600b10..2c61422 100644 --- a/docs/classes/Joint.html +++ b/docs/classes/Joint.html @@ -1,6 +1,6 @@ -Joint | Pixi3D - v2.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Joint

    +Joint | Pixi3D - v2.3.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
    • +

      Returns Quaternion

    • Parameters

      Returns 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
    • +

      Returns Quaternion

    • Parameters

      Returns 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
    • Protected property
    • Protected method
    • Static property
    • Static method

    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
    • Protected property
    • Protected method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Mat4.html b/docs/classes/Mat4.html index 4e2940a..c2b40cf 100644 --- a/docs/classes/Mat4.html +++ b/docs/classes/Mat4.html @@ -1 +1 @@ -Mat4 | Pixi3D - v2.3.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
    • Protected property
    • Protected method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Mat4 | Pixi3D - v2.3.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
    • Protected property
    • Protected method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Material.html b/docs/classes/Material.html index 97a1eea..e1b9f65 100644 --- a/docs/classes/Material.html +++ b/docs/classes/Material.html @@ -1,55 +1,55 @@ -Material | Pixi3D - v2.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Material

    +Material | Pixi3D - v2.3.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
    • Protected property
    • Protected method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Matrix4x4.html b/docs/classes/Matrix4x4.html index 24fd130..541f7f1 100644 --- a/docs/classes/Matrix4x4.html +++ b/docs/classes/Matrix4x4.html @@ -1,35 +1,35 @@ -Matrix4x4 | Pixi3D - v2.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Matrix4x4

    +Matrix4x4 | Pixi3D - v2.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Matrix4x4

    Represents a 4x4 matrix.

    -

    Hierarchy

    • Matrix
      • Matrix4x4

    Implements

    • TransformId

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

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

    Hierarchy

    • Matrix
      • Matrix4x4

    Implements

    • TransformId

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

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

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

    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

    Accessors

    backward

    down

    down

    forward

    forward

    left

    left

    position

    position

    right

    right

    rotation

    rotation

    scaling

    scaling

    transformId

    • get transformId(): number

    up

    transformId

    • get transformId(): number

    up

    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 Matrix4x4

      This matrix. Good for chaining method calls.

      -

    multiply

    multiply

    • Multiplies this matrix with another matrix.

      Parameters

      • matrix: Matrix4x4

        The matrix to multiply with.

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

        Matrix component

      Returns Matrix4x4

      This matrix. Good for chaining method calls.

      -

    setFrom

    setFrom

    setFromRotationPositionScale

    Returns Matrix4x4

    setFromRotationPositionScale

    • Sets the rotation, position and scale components.

      Parameters

      • rotation: Quaternion

        The rotation to set.

        @@ -150,20 +150,20 @@
      • skewY: number

        Skew on the y axis

      Returns Matrix4x4

      This matrix. Good for chaining method calls.

      -

    toArray

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

    • Parameters

      • transpose: boolean
      • Optional out: Float32Array

      Returns Float32Array

    toString

    • toString(): string

    • Returns string

    translate

    • +

    toArray

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

    • Parameters

      • transpose: boolean
      • Optional out: Float32Array

      Returns Float32Array

    toString

    • toString(): string

    • Returns string

    translate

    • Translates the matrix on the x and y.

      Parameters

      • x: number

        How much to translate x by

      • y: number

        How much to translate y by

      Returns Matrix4x4

      This matrix. Good for chaining method calls.

      -

    Static fromQuaternion

    Static fromQuaternion

    Static fromRotation

    Returns Matrix4x4

    Static fromRotation

    • Creates a matrix from a given angle around a given axis.

      Parameters

      • rad: number

        The angle in radians to rotate the matrix by.

        @@ -171,7 +171,7 @@

        The axis to rotate around.

      • out: Matrix4x4 = ...

        The receiving matrix. If not supplied, a new matrix will be created.

        -

      Returns Matrix4x4

    Static fromRotationTranslationScale

    Returns Matrix4x4

    Static fromRotationTranslationScale

    • Creates a matrix from a quaternion rotation, point translation and point scale.

      Parameters

      • q: Quaternion

        The rotation quaternion.

        @@ -181,29 +181,29 @@

        The scale point.

      • out: Matrix4x4 = ...

        The receiving matrix. If not supplied, a new matrix will be created.

        -

      Returns Matrix4x4

    Static fromScaling

    Returns Matrix4x4

    Static fromScaling

    Static fromTranslation

    Returns Matrix4x4

    Static fromTranslation

    Static identity

    Returns Matrix4x4

    Static identity

    Static invert

    Returns Matrix4x4

    Static invert

    Static lookAt

    Returns Matrix4x4

    Static lookAt

    • Generates a look-at matrix with the given eye position, focal point, and up axis. If you want a matrix that actually makes an object look at another object, you should use targetTo instead.

      Parameters

      • eye: Point3D

        The position of the viewer.

        @@ -213,7 +213,7 @@

        The vector pointing up.

      • out: Matrix4x4 = ...

        The receiving matrix. If not supplied, a new matrix will be created.

        -

      Returns Matrix4x4

    Static ortho

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

    Static ortho

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

    • Parameters

      • left: number

        The left bound of the frustum.

      • right: number

        The right bound of the frustum.

        @@ -227,7 +227,7 @@

        The far bound of the frustum.

      • out: Matrix4x4 = ...

        The receiving matrix. If not supplied, a new matrix will be created.

        -

      Returns Matrix4x4

    Static perspective

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

    Static perspective

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

    • Parameters

      • fovy: number

        The vertical field of view in radians.

      • aspect: number

        The aspect ratio, typically viewport width/height.

        @@ -237,7 +237,7 @@

        The far bound of the frustum.

      • out: Matrix4x4 = ...

        The receiving matrix. If not supplied, a new matrix will be created.

        -

      Returns Matrix4x4

    Static rotate

    Returns Matrix4x4

    Static rotate

    • Rotates a matrix by the given angle around the given axis.

      Parameters

      • a: Matrix4x4

        The matrix to rotate.

        @@ -247,7 +247,7 @@

        The axis to rotate around.

      • out: Matrix4x4 = ...

        The receiving matrix. If not supplied, a new matrix will be created.

        -

      Returns Matrix4x4

    Static rotateX

    Returns Matrix4x4

    Static rotateX

    • Rotates a matrix by the given angle around the x-axis.

      Parameters

      • a: Matrix4x4

        The matrix to rotate.

        @@ -255,7 +255,7 @@

        The angle in radians to rotate the matrix by.

      • out: Matrix4x4 = ...

        The receiving matrix. If not supplied, a new matrix will be created.

        -

      Returns Matrix4x4

    Static rotateY

    Returns Matrix4x4

    Static rotateY

    • Rotates a matrix by the given angle around the y-axis.

      Parameters

      • a: Matrix4x4

        The matrix to rotate.

        @@ -263,7 +263,7 @@

        The angle in radians to rotate the matrix by.

      • out: Matrix4x4 = ...

        The receiving matrix. If not supplied, a new matrix will be created.

        -

      Returns Matrix4x4

    Static rotateZ

    Returns Matrix4x4

    Static rotateZ

    • Rotates a matrix by the given angle around the z-axis.

      Parameters

      • a: Matrix4x4

        The matrix to rotate.

        @@ -271,7 +271,7 @@

        The angle in radians to rotate the matrix by.

      • out: Matrix4x4 = ...

        The receiving matrix. If not supplied, a new matrix will be created.

        -

      Returns Matrix4x4

    Static scale

    Returns Matrix4x4

    Static scale

    • Scales the matrix by the dimensions in the given point.

      Parameters

      • a: Matrix4x4

        The matrix to scale.

        @@ -279,7 +279,7 @@

        The point vector to scale the matrix by.

      • out: Matrix4x4 = ...

        The receiving matrix. If not supplied, a new matrix will be created.

        -

      Returns Matrix4x4

    Static targetTo

    Returns Matrix4x4

    Static targetTo

    • Generates a matrix that makes something look at something else.

      Parameters

      • eye: Point3D

        The position of the viewer.

        @@ -289,7 +289,7 @@

        The vector pointing up.

      • out: Matrix4x4 = ...

        The receiving matrix. If not supplied, a new matrix will be created.

        -

      Returns Matrix4x4

    Static translate

    Returns Matrix4x4

    Static translate

    • Translate a matrix by the given vector.

      Parameters

      • mat: Matrix4x4

        The matrix to translate.

        @@ -297,7 +297,7 @@

        The vector to translate by.

      • out: Matrix4x4 = ...

        The receiving matrix. If not supplied, a new matrix will be created.

        -

      Returns Matrix4x4

    Static transpose

    Returns Matrix4x4

    Static transpose

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

      Returns Quaternion

    • Parameters

      Returns 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 createCircle

    • createCircle(material?: Material, options?: CircleGeometryOptions): Mesh3D

    Static createCircle

    • createCircle(material?: Material, options?: CircleGeometryOptions): Mesh3D

    • Creates a new uv circle mesh with the specified material.

      Parameters

      • material: Material = ...

        The material to use.

      • options: CircleGeometryOptions = {}

        The options used when creating the geometry.

        -

      Returns Mesh3D

    Static createCube

    Returns Mesh3D

    Static createCube

    Static createCylinder

    • createCylinder(material?: Material, options?: CylinderGeometryOptions): Mesh3D

    Returns Mesh3D

    Static createCylinder

    • createCylinder(material?: Material, options?: CylinderGeometryOptions): Mesh3D

    • Creates a new uv cylinder mesh with the specified material.

      Parameters

      • material: Material = ...

        The material to use.

      • options: CylinderGeometryOptions = {}

        The options used when creating the geometry.

        -

      Returns Mesh3D

    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 9657748..aa64c89 100644 --- a/docs/classes/MeshShader.html +++ b/docs/classes/MeshShader.html @@ -1,4 +1,4 @@ -MeshShader | Pixi3D - v2.3.0
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Class MeshShader

        +MeshShader | Pixi3D - v2.3.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
    • +

      Returns Quaternion

    • Parameters

      Returns 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

    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

    Generated using TypeDoc

    \ No newline at end of file +

    object

    object: Mesh3D | Model

    Methods

    contains

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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/PickingInteraction.html b/docs/classes/PickingInteraction.html index e1e7860..275f8c3 100644 --- a/docs/classes/PickingInteraction.html +++ b/docs/classes/PickingInteraction.html @@ -1,15 +1,15 @@ -PickingInteraction | Pixi3D - v2.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class PickingInteraction

    +PickingInteraction | Pixi3D - v2.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class PickingInteraction

    Manages the picking hit areas by keeping track on which hit areas needs to be checked for interaction. Renders the hit area meshes to a texture which is then used to map a mesh to a x/y coordinate. The picking manager is registered as a renderer plugin.

    -

    Hierarchy

    • PickingInteraction

    Implements

    • IRendererPlugin

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    Hierarchy

    • PickingInteraction

    Implements

    • IRendererPlugin

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    Properties

    renderer

    renderer: Renderer

    Static main

    main: PickingInteraction
    +

    Returns PickingInteraction

    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
    • Protected property
    • Protected method
    • Static property
    • Static method

    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 bcc4f38..e2cf482 100644 --- a/docs/classes/Plane.html +++ b/docs/classes/Plane.html @@ -1 +1 @@ -Plane | Pixi3D - v2.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Plane

    Hierarchy

    • Plane

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    Properties

    distance

    distance: number

    Accessors

    normal

    Methods

    rayCast

    • rayCast(ray: Ray): number

    Static from

    Generated using TypeDoc

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

    Class Plane

    Hierarchy

    • Plane

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    Properties

    distance

    distance: number

    Accessors

    normal

    Methods

    rayCast

    • rayCast(ray: Ray): number

    Static from

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Point3D.html b/docs/classes/Point3D.html index 115a992..40abd0e 100644 --- a/docs/classes/Point3D.html +++ b/docs/classes/Point3D.html @@ -1,6 +1,6 @@ -Point3D | Pixi3D - v2.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Point3D

    +Point3D | Pixi3D - v2.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Point3D

    Represents a point in 3D space.

    -

    Hierarchy

    • ObservablePoint
      • Point3D

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

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

    Hierarchy

    • ObservablePoint
      • Point3D

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

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

    • Creates a new observable point.

      Parameters

      • x: number = 0

        The position on the x axis.

        @@ -16,31 +16,31 @@

        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

    magnitude

    • get magnitude(): number

    magnitude

    • get magnitude(): number

    x

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

    x

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

    • Position on the x axis relative to the local coordinates of the parent.

      -

      Returns number

    • +

      Returns number

    • Position on the x axis relative to the local coordinates of the parent.

      -

      Parameters

      • value: number

      Returns void

    y

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

    y

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

    • Position on the y axis relative to the local coordinates of the parent.

      -

      Returns number

    • +

      Returns number

    • Position on the y axis relative to the local coordinates of the parent.

      -

      Parameters

      • value: number

      Returns void

    z

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

    z

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

    Methods

    clone

    • clone(cb?: () => any, scope?: any): Point3D

    • Parameters

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

            Parameters

            • value: number

            Returns void

    Methods

    clone

    • clone(cb?: () => any, scope?: any): Point3D

    • Parameters

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

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

            -

            Returns any

      • scope: any = ...

      Returns Point3D

    copyFrom

    copyTo

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

    equals

    normalize

  • scope: any = ...

    • Returns Point3D

    copyFrom

    copyTo

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

    equals

    normalize

    set

    • set(x: number, y?: number, z?: number): Point3D

    Returns Point3D

    set

    • set(x: number, y?: number, z?: number): Point3D

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

      Parameters

      • x: number

        The position on the x axis.

        @@ -48,11 +48,11 @@

        The position on the y axis.

      • z: number = x

        The position on the z axis.

        -

      Returns Point3D

    setFrom

    • setFrom(array: ArrayLike<number>): Point3D

    Returns Point3D

    setFrom

    • setFrom(array: ArrayLike<number>): Point3D

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

      Parameters

      • array: ArrayLike<number>

        The array containing x, y and z, expected length is 3.

        -

      Returns Point3D

    toString

    • toString(): string

    • Returns string

    Static add

    Returns Point3D

    toString

    • toString(): string

    • Returns string

    Static add

    Static cross

    Returns Point3D

    Static cross

    • Computes the cross product of two points.

      Parameters

      • a: Point3D

        The first point.

        @@ -68,25 +68,25 @@

        The second point.

      • out: Point3D = ...

        The receiving point. If not supplied, a new point will be created.

        -

      Returns Point3D

    Static distance

    Returns Point3D

    Static distance

    Static dot

    Returns number

    Static dot

    Static inverse

    Returns number

    Static inverse

    Static lerp

    Returns Point3D

    Static lerp

    • Performs a linear interpolation between two points.

      Parameters

      • a: Point3D

        The first point.

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

        The interpolation amount, in the range [0-1], between the two inputs.

      • out: Point3D = ...

        The receiving point. If not supplied, a new point will be created.

        -

      Returns Point3D

    Static multiply

    Returns Point3D

    Static multiply

    • Multiplies two points.

      Parameters

      • a: Point3D

        The first point.

        @@ -104,13 +104,13 @@

        The second point.

      • out: Point3D = ...

        The receiving point. If not supplied, a new point will be created.

        -

      Returns Point3D

    Static negate

    Returns Point3D

    Static negate

    Static scale

    Returns Point3D

    Static scale

    • Scales a point by a scalar number.

      Parameters

      • a: Point3D

        The point to scale.

        @@ -118,13 +118,13 @@

        The amount to scale the point by.

      • out: Point3D = ...

        The receiving point. If not supplied, a new point will be created.

        -

      Returns Point3D

    Static squaredDistance

    Returns Point3D

    Static squaredDistance

    Static subtract

    Returns number

    Static subtract

    • Subtracts the second point from the first point.

      Parameters

      • a: Point3D

        The first point.

        @@ -132,7 +132,7 @@

        The second point.

      • out: Point3D = ...

        The receiving point. If not supplied, a new point will be created.

        -

      Returns Point3D

    Static transform

    Returns Point3D

    Static transform

    • Transforms a point with a matrix or quaternion.

      Parameters

      • a: Point3D

        The point to transform.

        diff --git a/docs/classes/Quat.html b/docs/classes/Quat.html index 4878c15..5db211c 100644 --- a/docs/classes/Quat.html +++ b/docs/classes/Quat.html @@ -1 +1 @@ -Quat | Pixi3D - v2.3.0
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Class Quat

        Hierarchy

        • Quat

        Index

        Constructors

        Methods

        Constructors

        constructor

        Methods

        Static conjugate

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

        • Parameters

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

          Returns Float32Array

        Static create

        • create(): Float32Array

        Static fromEuler

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

        • Parameters

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

          Returns Float32Array

        Static fromValues

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

        • Parameters

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

          Returns Float32Array

        Static normalize

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

        • Parameters

          • a: 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 rotationTo

        • rotationTo(from: Float32Array, to: Float32Array, out?: Float32Array): Float32Array

        • Parameters

          • from: Float32Array
          • to: Float32Array
          • out: Float32Array = ...

          Returns Float32Array

        Static set

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

        • Parameters

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

          Returns Float32Array

        Static slerp

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

        • Parameters

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

          Returns Float32Array

        Legend

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

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file +Quat | Pixi3D - v2.3.1
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Class Quat

        Hierarchy

        • Quat

        Index

        Constructors

        Methods

        Constructors

        constructor

        Methods

        Static conjugate

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

        • Parameters

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

          Returns Float32Array

        Static create

        • create(): Float32Array

        Static fromEuler

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

        • Parameters

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

          Returns Float32Array

        Static fromValues

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

        • Parameters

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

          Returns Float32Array

        Static normalize

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

        • Parameters

          • a: 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 rotationTo

        • rotationTo(from: Float32Array, to: Float32Array, out?: Float32Array): Float32Array

        • Parameters

          • from: Float32Array
          • to: Float32Array
          • out: Float32Array = ...

          Returns Float32Array

        Static set

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

        • Parameters

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

          Returns Float32Array

        Static slerp

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

        • Parameters

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

          Returns Float32Array

        Legend

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

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/classes/Quaternion.html b/docs/classes/Quaternion.html index af5a65b..b46ecfb 100644 --- a/docs/classes/Quaternion.html +++ b/docs/classes/Quaternion.html @@ -1,6 +1,6 @@ -Quaternion | Pixi3D - v2.3.0
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Class Quaternion

        +Quaternion | Pixi3D - v2.3.1
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Class Quaternion

        Represents a rotation quaternion in 3D space.

        -

        Hierarchy

        • ObservablePoint
          • Quaternion

        Index

        Constructors

        Properties

        Accessors

        Methods

        Constructors

        constructor

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

        Hierarchy

        • ObservablePoint
          • Quaternion

        Index

        Constructors

        Properties

        Accessors

        Methods

        Constructors

        constructor

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

        • Creates a new observable quaternion.

          Parameters

          • x: number = 0

            The x component.

            @@ -18,27 +18,27 @@

            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

    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,23 +46,23 @@

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

        Returns any

  • scope: any = ...

    Owner of callback.

    -

    • Returns Quaternion

    copyFrom

    Returns Quaternion

    copyFrom

    copyTo

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

    Returns Quaternion

    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

    • Returns true if the given quaternion is equal to this quaternion.

      Parameters

      Returns boolean

    normalize

    Returns boolean

    normalize

    set

    • set(x: number, y?: number, z?: number, w?: number): Quaternion

    Returns Quaternion

    set

    • set(x: number, y?: number, z?: number, w?: number): Quaternion

    • Sets the quaternion to new x, y, z and w components.

      Parameters

      • x: number

        X component to set.

        @@ -72,7 +72,7 @@

        Z component to set.

      • w: number = x

        W component to set.

        -

      Returns Quaternion

    setEulerAngles

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

    Returns Quaternion

    setEulerAngles

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

    • Sets the euler angles in degrees.

      Parameters

      • x: number

        The x angle.

        @@ -80,18 +80,18 @@

        The y angle.

      • z: number

        The z angle.

        -

      Returns void

    setFrom

    Returns void

    setFrom

    • Sets the quaternion to a new x, y, z and w components.

      Parameters

      • array: ArrayLike<number>

        The array containing x, y, z and w, expected length is 4.

        -

      Returns Quaternion

    toString

    • toString(): string

    • Returns string

    Static conjugate

    Returns Quaternion

    toString

    • toString(): string

    • Returns string

    Static conjugate

    Static fromEuler

    Returns Quaternion

    Static fromEuler

    • Creates a quaternion from the given euler angle x, y, z.

      Parameters

      • x: number

        X axis to rotate around in degrees.

        @@ -102,7 +102,7 @@
      • out: Quaternion = ...

        The receiving quaternion. If not supplied, a new quaternion will be created.

        -

      Returns Quaternion

    Static rotateX

    Returns Quaternion

    Static rotateX

    Static rotateY

    Returns Quaternion

    Static rotateY

    Static rotateZ

    Returns Quaternion

    Static rotateZ

    Static slerp

    Returns Quaternion

    Static slerp

    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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Skin.html b/docs/classes/Skin.html index 56c3937..b719640 100644 --- a/docs/classes/Skin.html +++ b/docs/classes/Skin.html @@ -1,15 +1,15 @@ -Skin | Pixi3D - v2.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Skin

    +Skin | Pixi3D - v2.3.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
    • Protected property
    • Protected method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Skybox.html b/docs/classes/Skybox.html index b71279f..52c36b7 100644 --- a/docs/classes/Skybox.html +++ b/docs/classes/Skybox.html @@ -1,8 +1,8 @@ -Skybox | Pixi3D - v2.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Skybox

    +Skybox | Pixi3D - v2.3.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,27 +80,27 @@

    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.

      -

      Returns boolean

    exposure

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

    exposure

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

    height

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

    • 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 @@ -140,15 +140,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
    • +

      Returns Quaternion

    • Parameters

      Returns 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>

    • @@ -158,7 +158,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. @@ -172,10 +172,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
    • @@ -430,7 +430,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.

      @@ -26,13 +26,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 8f613f5..2c0e94d 100644 --- a/docs/classes/Vec3.html +++ b/docs/classes/Vec3.html @@ -1 +1 @@ -Vec3 | Pixi3D - v2.3.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): Float32Array

        • Parameters

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

          Returns Float32Array

        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
        • Protected property
        • Protected method
        • Static property
        • Static method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file +Vec3 | Pixi3D - v2.3.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): Float32Array

        • Parameters

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

          Returns Float32Array

        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
        • Protected property
        • Protected method
        • Static property
        • Static method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/classes/glTFAsset.html b/docs/classes/glTFAsset.html index 1c41978..8c6fa48 100644 --- a/docs/classes/glTFAsset.html +++ b/docs/classes/glTFAsset.html @@ -1,6 +1,6 @@ -glTFAsset | Pixi3D - v2.3.0
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Class glTFAsset

        +glTFAsset | Pixi3D - v2.3.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,27 +8,27 @@

            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 fromURL

    • fromURL(url: string, options?: RequestInit): Promise<glTFAsset>

    Returns void

    Static fromURL

    • fromURL(url: string, options?: RequestInit): Promise<glTFAsset>

    • Loads a gltf asset from the specified url. This feature is only available when using PixiJS v7+.

      Parameters

      • url: string

        The url to load.

        -
      • Optional options: RequestInit

      Returns Promise<glTFAsset>

    Static isEmbeddedResource

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

    Returns Promise<glTFAsset>

    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