From 71645c64e1ed138aa72de2eb50c03a2167ea5fc8 Mon Sep 17 00:00:00 2001 From: Jens Malmborg Date: Fri, 7 Jan 2022 20:23:58 +0100 Subject: [PATCH] 1.1.2 --- docs/classes/Animation.html | 18 ++-- docs/classes/Camera.html | 60 ++++++------- docs/classes/CameraOrbitControl.html | 16 ++-- docs/classes/Color.html | 30 +++---- docs/classes/Container3D.html | 18 ++-- docs/classes/Cubemap.html | 10 +-- docs/classes/CubemapResource.html | 4 +- docs/classes/ImageBasedLighting.html | 14 +-- docs/classes/InstancedMesh3D.html | 18 ++-- docs/classes/InstancedModel.html | 22 ++--- docs/classes/InstancedStandardMaterial.html | 6 +- docs/classes/Joint.html | 20 ++--- docs/classes/Light.html | 26 +++--- docs/classes/LightingEnvironment.html | 14 +-- docs/classes/Mat4.html | 2 +- docs/classes/Material.html | 32 +++---- docs/classes/MaterialRenderPass.html | 14 +-- docs/classes/Matrix4.html | 32 +++---- docs/classes/Mesh3D.html | 52 +++++------ docs/classes/MeshGeometry3D.html | 10 +-- docs/classes/MeshShader.html | 8 +- docs/classes/Model.html | 26 +++--- docs/classes/ObservablePoint3D.html | 24 ++--- docs/classes/ObservableQuaternion.html | 38 ++++---- docs/classes/PickingHitArea.html | 8 +- docs/classes/PickingInteraction.html | 8 +- docs/classes/Plane.html | 2 +- docs/classes/PostProcessingSprite.html | 12 +-- docs/classes/Quat.html | 2 +- docs/classes/Ray.html | 2 +- docs/classes/ShadowCastingLight.html | 28 +++--- docs/classes/ShadowRenderPass.html | 12 +-- docs/classes/Skin.html | 10 +-- docs/classes/Skybox.html | 30 +++---- docs/classes/Sprite3D.html | 50 +++++------ docs/classes/SpriteBatchRenderer.html | 4 +- docs/classes/StandardMaterial.html | 88 +++++++++---------- .../StandardMaterialNormalTexture.html | 6 +- .../StandardMaterialOcclusionTexture.html | 6 +- docs/classes/StandardMaterialTexture.html | 6 +- docs/classes/StandardPipeline.html | 22 ++--- docs/classes/TextureTransform.html | 14 +-- docs/classes/Transform3D.html | 24 ++--- docs/classes/Vec3.html | 2 +- docs/classes/glTFAsset.html | 12 +-- docs/enums/LightType.html | 6 +- docs/enums/MaterialRenderSortType.html | 2 +- docs/enums/ShadowQuality.html | 6 +- docs/enums/SpriteBillboardType.html | 6 +- docs/enums/StandardMaterialAlphaMode.html | 6 +- docs/enums/StandardMaterialDebugMode.html | 2 +- docs/index.html | 2 +- docs/interfaces/CubemapFaces.html | 12 +-- docs/interfaces/MaterialFactory.html | 4 +- docs/interfaces/MeshDestroyOptions.html | 2 +- docs/interfaces/MeshGeometryAttribute.html | 12 +-- docs/interfaces/MeshGeometryTarget.html | 4 +- .../PostProcessingSpriteOptions.html | 6 +- docs/interfaces/RenderPass.html | 8 +- .../interfaces/ShadowCastingLightOptions.html | 4 +- docs/interfaces/glTFResourceLoader.html | 4 +- docs/modules.html | 2 +- docs/modules/Debug.html | 2 +- package-lock.json | 2 +- package.json | 2 +- 65 files changed, 478 insertions(+), 478 deletions(-) diff --git a/docs/classes/Animation.html b/docs/classes/Animation.html index 9a156f32..7557ac27 100644 --- a/docs/classes/Animation.html +++ b/docs/classes/Animation.html @@ -1,16 +1,16 @@ -Animation | Pixi3D - v1.1.1
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Animation

+Animation | Pixi3D - v1.1.2
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Animation

Represents an animation.

-

Hierarchy

  • EventEmitter
    • Animation

Index

Constructors

Properties

Methods

Constructors

constructor

Hierarchy

  • EventEmitter
    • Animation

Index

Constructors

Properties

Methods

Constructors

constructor

  • Creates a new animation with the specified name.

    Parameters

    • Optional name: string

      Name for the animation.

      -

    Returns Animation

Properties

Readonly Abstract duration

duration: number
+

Returns Animation

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 = PIXI.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

Properties

Optional _accessibleActive

_accessibleActive?: boolean

Optional _accessibleDiv

_accessibleDiv?: IAccessibleHTMLElement

_bounds

_bounds: Bounds

Protected _boundsID

_boundsID: number

Protected _boundsRect

_boundsRect: Rectangle

Optional _cacheAsBitmap

_cacheAsBitmap?: boolean

Optional _cacheAsBitmapResolution

_cacheAsBitmapResolution?: number

Optional _cacheData

_cacheData?: CacheData

Protected _destroyed

_destroyed: boolean

Protected _enabledFilters

_enabledFilters: Filter[]

Protected _height

_height: number

_lastSortedIndex

_lastSortedIndex: number

_localBounds

_localBounds: Bounds

Protected _localBoundsRect

_localBoundsRect: Rectangle

_mask

_mask: Container | MaskData

Optional _trackedPointers

_trackedPointers?: {}

Type declaration

  • [x: number]: InteractionTrackingData

Protected _width

_width: number

Protected _zIndex

_zIndex: number

Optional accessible

accessible?: boolean

Optional accessibleChildren

accessibleChildren?: true

Optional accessibleHint

accessibleHint?: string

Optional accessiblePointerEvents

accessiblePointerEvents?: PointerEvents

Optional accessibleTitle

accessibleTitle?: string

Optional accessibleType

accessibleType?: string

alpha

alpha: number

Optional buttonMode

buttonMode?: boolean

Optional cacheAsBitmap

cacheAsBitmap?: boolean

Optional cacheAsBitmapResolution

cacheAsBitmapResolution?: number

Readonly children

children: DisplayObject[]

containerUpdateTransform

containerUpdateTransform: () => void

Type declaration

    • (): void

    • Returns void

Optional cursor

cursor?: string

displayObjectUpdateTransform

displayObjectUpdateTransform: () => void

Type declaration

    • (): void

    • Returns void

filterArea

filterArea: Rectangle

filters

filters: Filter[]

Optional hitArea

hitArea?: IHitArea

Optional interactive

interactive?: boolean

Optional interactiveChildren

interactiveChildren?: boolean

isMask

isMask: boolean

isSprite

isSprite: boolean

Optional name

name?: string

parent

parent: Container

Optional renderId

renderId?: number

renderable

renderable: boolean

renderer

renderer: Renderer

sortDirty

sortDirty: boolean

sortableChildren

sortableChildren: boolean

Optional tabIndex

tabIndex?: number

Optional trackedPointers

trackedPointers?: {}

Type declaration

  • [x: number]: InteractionTrackingData

transform

transform: Transform3D = ...

visible

visible: boolean

worldAlpha

worldAlpha: number

Static main

main: Camera

Main camera which is used by default.

Static prefixed

prefixed: string | boolean

Accessors

Protected _tempDisplayObjectParent

  • get _tempDisplayObjectParent(): TemporaryDisplayObject
  • member

    {PIXI.Container}

    Returns TemporaryDisplayObject

angle

  • get angle(): number
  • set angle(value: number): void
  • @@ -16,19 +16,19 @@

    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.

    member

    {number}

    -

    Parameters

    • value: number

    Returns void

aspect

  • get aspect(): undefined | number
  • set aspect(value: undefined | number): void

aspect

  • get aspect(): undefined | number
  • set aspect(value: undefined | number): void

  • The aspect ratio (width divided by height). If not set, the aspect ratio of the renderer will be used by default.

    -

    Returns undefined | number

  • +

    Returns undefined | number

  • The aspect ratio (width divided by height). If not set, the aspect ratio of the renderer will be used by default.

    -

    Parameters

    • value: undefined | number

    Returns void

far

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

far

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

fieldOfView

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

fieldOfView

  • get fieldOfView(): number
  • set fieldOfView(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

    @@ -36,7 +36,7 @@

    Returns number

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

    member

    {number}

    -

    Parameters

    • value: number

    Returns void

localTransform

mask

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

    Parameters

    • value: number

    Returns void

localTransform

mask

  • get mask(): null | Container | MaskData
  • set mask(value: null | Container | 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 @@ -64,26 +64,26 @@ sprite.mask = graphics;

    todo

    At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.

    member

    {PIXI.Container|PIXI.MaskData|null}

    -

    Parameters

    • value: null | Container | MaskData

    Returns void

near

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

near

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

obliqueness

  • get obliqueness(): IPointData
  • set obliqueness(value: IPointData): void

obliqueness

  • get obliqueness(): IPointData
  • set obliqueness(value: IPointData): void

  • Used for making the frustum oblique, which means that one side is at a smaller angle to the centre line than the opposite side. Only works with perspective projection.

    -

    Returns IPointData

  • +

    Returns IPointData

  • Used for making the frustum oblique, which means that one side is at a smaller angle to the centre line than the opposite side. Only works with perspective projection.

    -

    Parameters

    • value: IPointData

    Returns void

orthographic

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

orthographic

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

orthographicSize

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

orthographicSize

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

  • The camera's half-size when in orthographic mode. The visible area from center of the screen to the top.

    -

    Returns number

  • +

    Returns number

  • The camera's half-size when in orthographic mode. The visible area from center of the screen to the top.

    Parameters

    • value: number

    Returns void

pivot

  • get pivot(): ObservablePoint<any>
  • set pivot(value: ObservablePoint<any>): void
  • @@ -98,7 +98,7 @@

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

    since

    PixiJS 4

    member

    {PIXI.ObservablePoint}

    -

    Parameters

    • value: ObservablePoint<any>

    Returns void

position

projection

  • get projection(): Float32Array

position

projection

  • get projection(): Float32Array

rotation

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

  • The rotation of the object in radians. @@ -108,9 +108,9 @@

    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.

    member

    {number}

    -

    Parameters

    • value: number

    Returns void

rotationQuaternion

  • +

    Parameters

    • value: number

    Returns void

rotationQuaternion

scale

skew

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

scale

skew

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

  • The skew factor for the object in radians.

    since

    PixiJS 4

    member

    {PIXI.ObservablePoint}

    @@ -118,9 +118,9 @@

    The skew factor for the object in radians.

    since

    PixiJS 4

    member

    {PIXI.ObservablePoint}

    -

Parameters

  • value: ObservablePoint<any>

Returns void

transformId

  • get transformId(): number

view

  • get view(): Float32Array

transformId

  • get transformId(): number

view

  • get view(): Float32Array

viewProjection

  • get viewProjection(): Float32Array

viewProjection

  • get viewProjection(): Float32Array

width

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

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

    @@ -128,7 +128,7 @@

    Returns number

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

    member

    {number}

    -

    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.

    member

    {boolean}

    readonly

    Returns boolean

x

  • get x(): number
  • set x(value: number): void
  • @@ -147,10 +147,10 @@

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

    member

    {number}

    -

    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
  • @@ -192,7 +192,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?: boolean | IDestroyOptions): void

destroy

  • destroy(options?: 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

    • Optional options: boolean | IDestroyOptions

    Returns void

disableTempParent

  • disableTempParent(cacheParent: DisplayObject): void
  • @@ -296,7 +296,7 @@

    Render the object using the WebGL renderer and advanced features.

    Parameters

    • renderer: Renderer

      The renderer

      -

    Returns void

Optional renderCanvas

  • renderCanvas(renderer: CanvasRenderer): void

  • Parameters

    • renderer: CanvasRenderer

    Returns void

screenToRay

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

Returns void

Optional renderCanvas

  • renderCanvas(renderer: CanvasRenderer): void

  • Parameters

    • renderer: CanvasRenderer

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

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

      Screen y coordinate.

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

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

      -
      • height: number
      • width: number

    Returns undefined | Ray

screenToWorld

Returns undefined | Ray

screenToWorld

  • Converts screen coordinates to world coordinates.

    Parameters

    • x: number

      Screen x coordinate.

      @@ -350,7 +350,7 @@
    • Optional from: DisplayObject
    • Optional point: P
    • Optional skipUpdate: boolean

    Returns P

    A point object representing the position of this object

updateTransform

  • updateTransform(): void

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

    -

    Returns void

worldToScreen

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

worldToScreen

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

Properties

allowControl

allowControl: boolean = true

Allows the camera to be controlled by user.

-

camera

camera: Camera = Camera.main

target

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

camera

camera: Camera = Camera.main

target

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

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

-

Type declaration

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

Accessors

angles

  • get angles(): ObservablePoint<undefined>

Accessors

angles

  • get angles(): ObservablePoint<undefined>

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

    -

    Returns ObservablePoint<undefined>

distance

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

distance

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

Methods

updateCamera

  • updateCamera(): void

Methods

updateCamera

  • updateCamera(): void

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/Color.html b/docs/classes/Color.html index 8ac42737..093207d0 100644 --- a/docs/classes/Color.html +++ b/docs/classes/Color.html @@ -1,6 +1,6 @@ -Color | Pixi3D - v1.1.1
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Color

+Color | Pixi3D - v1.1.2
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

  • Creates a new color from the specified hex value.

    Parameters

    • hex: string | number

      The hex value as a string or a number.

      diff --git a/docs/classes/Container3D.html b/docs/classes/Container3D.html index 0a8e2010..137cc463 100644 --- a/docs/classes/Container3D.html +++ b/docs/classes/Container3D.html @@ -1,6 +1,6 @@ -Container3D | Pixi3D - v1.1.1
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Class Container3D

      +Container3D | Pixi3D - v1.1.2
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Class Container3D

      A container represents a collection of 3D objects.

      -

      Hierarchy

      Index

      Constructors

      Properties

      Accessors

      Methods

      Constructors

      constructor

      • Returns Container3D

      Properties

      Optional _accessibleActive

      _accessibleActive?: boolean

      Optional _accessibleDiv

      _accessibleDiv?: IAccessibleHTMLElement

      _bounds

      _bounds: Bounds

      Protected _boundsID

      _boundsID: number

      Protected _boundsRect

      _boundsRect: Rectangle

      Optional _cacheAsBitmap

      _cacheAsBitmap?: boolean

      Optional _cacheAsBitmapResolution

      _cacheAsBitmapResolution?: number

      Optional _cacheData

      _cacheData?: CacheData

      Protected _destroyed

      _destroyed: boolean

      Protected _enabledFilters

      _enabledFilters: Filter[]

      Protected _height

      _height: number

      _lastSortedIndex

      _lastSortedIndex: number

      _localBounds

      _localBounds: Bounds

      Protected _localBoundsRect

      _localBoundsRect: Rectangle

      _mask

      _mask: Container | MaskData

      Optional _trackedPointers

      _trackedPointers?: {}

      Type declaration

      • [x: number]: InteractionTrackingData

      Protected _width

      _width: number

      Protected _zIndex

      _zIndex: number

      Optional accessible

      accessible?: boolean

      Optional accessibleChildren

      accessibleChildren?: true

      Optional accessibleHint

      accessibleHint?: string

      Optional accessiblePointerEvents

      accessiblePointerEvents?: PointerEvents

      Optional accessibleTitle

      accessibleTitle?: string

      Optional accessibleType

      accessibleType?: string

      alpha

      alpha: number

      Optional buttonMode

      buttonMode?: boolean

      Optional cacheAsBitmap

      cacheAsBitmap?: boolean

      Optional cacheAsBitmapResolution

      cacheAsBitmapResolution?: number

      Readonly children

      children: DisplayObject[]

      containerUpdateTransform

      containerUpdateTransform: () => void

      Type declaration

        • (): void

        • Returns void

      Optional cursor

      cursor?: string

      displayObjectUpdateTransform

      displayObjectUpdateTransform: () => void

      Type declaration

        • (): void

        • Returns void

      filterArea

      filterArea: Rectangle

      filters

      filters: Filter[]

      Optional hitArea

      hitArea?: IHitArea

      Optional interactive

      interactive?: boolean

      Optional interactiveChildren

      interactiveChildren?: boolean

      isMask

      isMask: boolean

      isSprite

      isSprite: boolean

      Optional name

      name?: string

      parent

      parent: Container

      Optional renderId

      renderId?: number

      renderable

      renderable: boolean

      sortDirty

      sortDirty: boolean

      sortableChildren

      sortableChildren: boolean

      Optional tabIndex

      tabIndex?: number

      Optional trackedPointers

      trackedPointers?: {}

      Type declaration

      • [x: number]: InteractionTrackingData

      transform

      transform: Transform3D = ...

      visible

      visible: boolean

      worldAlpha

      worldAlpha: number

      Static prefixed

      prefixed: string | boolean

      Accessors

      Protected _tempDisplayObjectParent

      • get _tempDisplayObjectParent(): TemporaryDisplayObject
      • member

        {PIXI.Container}

        +

      Hierarchy

      Index

      Constructors

      Properties

      Accessors

      Methods

      Constructors

      constructor

      • Returns Container3D

      Properties

      Optional _accessibleActive

      _accessibleActive?: boolean

      Optional _accessibleDiv

      _accessibleDiv?: IAccessibleHTMLElement

      _bounds

      _bounds: Bounds

      Protected _boundsID

      _boundsID: number

      Protected _boundsRect

      _boundsRect: Rectangle

      Optional _cacheAsBitmap

      _cacheAsBitmap?: boolean

      Optional _cacheAsBitmapResolution

      _cacheAsBitmapResolution?: number

      Optional _cacheData

      _cacheData?: CacheData

      Protected _destroyed

      _destroyed: boolean

      Protected _enabledFilters

      _enabledFilters: Filter[]

      Protected _height

      _height: number

      _lastSortedIndex

      _lastSortedIndex: number

      _localBounds

      _localBounds: Bounds

      Protected _localBoundsRect

      _localBoundsRect: Rectangle

      _mask

      _mask: Container | MaskData

      Optional _trackedPointers

      _trackedPointers?: {}

      Type declaration

      • [x: number]: InteractionTrackingData

      Protected _width

      _width: number

      Protected _zIndex

      _zIndex: number

      Optional accessible

      accessible?: boolean

      Optional accessibleChildren

      accessibleChildren?: true

      Optional accessibleHint

      accessibleHint?: string

      Optional accessiblePointerEvents

      accessiblePointerEvents?: PointerEvents

      Optional accessibleTitle

      accessibleTitle?: string

      Optional accessibleType

      accessibleType?: string

      alpha

      alpha: number

      Optional buttonMode

      buttonMode?: boolean

      Optional cacheAsBitmap

      cacheAsBitmap?: boolean

      Optional cacheAsBitmapResolution

      cacheAsBitmapResolution?: number

      Readonly children

      children: DisplayObject[]

      containerUpdateTransform

      containerUpdateTransform: () => void

      Type declaration

        • (): void

        • Returns void

      Optional cursor

      cursor?: string

      displayObjectUpdateTransform

      displayObjectUpdateTransform: () => void

      Type declaration

        • (): void

        • Returns void

      filterArea

      filterArea: Rectangle

      filters

      filters: Filter[]

      Optional hitArea

      hitArea?: IHitArea

      Optional interactive

      interactive?: boolean

      Optional interactiveChildren

      interactiveChildren?: boolean

      isMask

      isMask: boolean

      isSprite

      isSprite: boolean

      Optional name

      name?: string

      parent

      parent: Container

      Optional renderId

      renderId?: number

      renderable

      renderable: boolean

      sortDirty

      sortDirty: boolean

      sortableChildren

      sortableChildren: boolean

      Optional tabIndex

      tabIndex?: number

      Optional trackedPointers

      trackedPointers?: {}

      Type declaration

      • [x: number]: InteractionTrackingData

      transform

      transform: Transform3D = ...

      visible

      visible: boolean

      worldAlpha

      worldAlpha: number

      Static prefixed

      prefixed: string | boolean

      Accessors

      Protected _tempDisplayObjectParent

      • get _tempDisplayObjectParent(): TemporaryDisplayObject
      • member

        {PIXI.Container}

        Returns TemporaryDisplayObject

      angle

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

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

        @@ -15,7 +15,7 @@

        Returns number

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

        member

        {number}

        -

        Parameters

        • value: number

        Returns void

      localTransform

      mask

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

        Parameters

        • value: number

        Returns void

      localTransform

      mask

      • get mask(): null | Container | MaskData
      • set mask(value: null | Container | 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 @@ -55,7 +55,7 @@

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

        since

        PixiJS 4

        member

        {PIXI.ObservablePoint}

        -

        Parameters

        • value: ObservablePoint<any>

        Returns void

      position

      rotation

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

        Parameters

        • value: ObservablePoint<any>

        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.

        member

        {number}

        @@ -63,9 +63,9 @@

        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.

        member

        {number}

        -

      Parameters

      • value: number

      Returns void

rotationQuaternion

rotationQuaternion

scale

skew

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

scale

skew

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

  • The skew factor for the object in radians.

    since

    PixiJS 4

    member

    {PIXI.ObservablePoint}

    @@ -79,7 +79,7 @@

    Returns number

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

    member

    {number}

    -

    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.

    member

    {boolean}

    readonly

    Returns boolean

x

  • get x(): number
  • set x(value: number): void
  • @@ -98,10 +98,10 @@

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

    member

    {number}

    -

    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 101440f8..c41eca4a 100644 --- a/docs/classes/Cubemap.html +++ b/docs/classes/Cubemap.html @@ -1,9 +1,9 @@ -Cubemap | Pixi3D - v1.1.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Cubemap

    +Cubemap | Pixi3D - v1.1.2
    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>

      Returns Cubemap

    Properties

    _batchEnabled

    _batchEnabled: number

    _batchLocation

    _batchLocation: number

    _glTextures

    _glTextures: {}

    Type declaration

    • [key: number]: GLTexture

    Optional alphaMode

    alphaMode?: ALPHA_MODES

    Optional anisotropicLevel

    anisotropicLevel?: number

    cacheId

    cacheId: string

    destroyed

    destroyed: boolean

    dirtyId

    dirtyId: number

    dirtyStyleId

    dirtyStyleId: number

    Optional format

    format?: FORMATS

    height

    height: number

    isPowerOfTwo

    isPowerOfTwo: boolean

    Optional mipmap

    mipmap?: MIPMAP_MODES

    parentTextureArray

    parentTextureArray: BaseTexture<Resource, IAutoDetectOptions>

    resolution

    resolution: number

    resource

    resource: CubemapResource

    Optional scaleMode

    scaleMode?: SCALE_MODES

    Optional target

    target?: TARGETS

    textureCacheIds

    textureCacheIds: string[]

    touched

    touched: number

    Optional type

    type?: TYPES

    Readonly uid

    uid: number

    valid

    valid: boolean

    width

    width: number

    Optional wrapMode

    wrapMode?: WRAP_MODES

    Static _globalBatch

    _globalBatch: number

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

    static
    member

    {number}

    -

    Static prefixed

    prefixed: string | boolean

    Accessors

    levels

    • get levels(): number

    Static prefixed

    prefixed: string | boolean

    Accessors

    levels

    • get levels(): number

    realHeight

    • get realHeight(): number

    • Pixel height of the source of this texture

      @@ -11,7 +11,7 @@

      Returns number

    realWidth

    • get realWidth(): number

    • Pixel width of the source of this texture

      readonly
      member

      {number}

      -

      Returns number

    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

      @@ -96,7 +96,7 @@
    • height: number

      Height of the resource

    • Optional options: IBaseTextureOptions<any>

    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.

      @@ -110,7 +110,7 @@

      The color for positive z.

    • negz: Color = posx

      The color for negative z.

      -

    Returns Cubemap

Static fromFaces

Returns Cubemap

Static fromFaces

  • Creates a new cubemap from the specified faces.

    Parameters

    • faces: CubemapFaces | CubemapFaces[]

      The faces to create the cubemap from.

      diff --git a/docs/classes/CubemapResource.html b/docs/classes/CubemapResource.html index a76814db..5fb1dbe0 100644 --- a/docs/classes/CubemapResource.html +++ b/docs/classes/CubemapResource.html @@ -1,4 +1,4 @@ -CubemapResource | Pixi3D - v1.1.1
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Class CubemapResource

      Hierarchy

      • CubeResource
        • CubemapResource

      Index

      Constructors

      Properties

      Accessors

      Methods

      Constructors

      constructor

      • new CubemapResource(source: MipmapResourceArray, levels?: number): CubemapResource

      Properties

      Protected _height

      _height: number

      Protected _width

      _width: number

      baseTexture

      baseTexture: BaseTexture<Resource, IAutoDetectOptions>

      destroyed

      destroyed: boolean

      internal

      internal: boolean

      itemDirtyIds

      itemDirtyIds: number[]

      items

      items: ArrayFixed<BaseTexture<Resource, IAutoDetectOptions>, 6>

      Readonly length

      length: number

      levels

      levels: number = 1

      linkBaseTexture

      linkBaseTexture: boolean

      Protected onError

      onError: Runner

      Protected onResize

      onResize: Runner

      Protected onUpdate

      onUpdate: Runner

      Static SIDES

      SIDES: number
      +CubemapResource | Pixi3D - v1.1.2
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Class CubemapResource

      Hierarchy

      • CubeResource
        • CubemapResource

      Index

      Constructors

      Properties

      Accessors

      Methods

      Constructors

      constructor

      • new CubemapResource(source: MipmapResourceArray, levels?: number): CubemapResource

      Properties

      Protected _height

      _height: number

      Protected _width

      _width: number

      baseTexture

      baseTexture: BaseTexture<Resource, IAutoDetectOptions>

      destroyed

      destroyed: boolean

      internal

      internal: boolean

      itemDirtyIds

      itemDirtyIds: number[]

      items

      items: ArrayFixed<BaseTexture<Resource, IAutoDetectOptions>, 6>

      Readonly length

      length: number

      levels

      levels: number = 1

      linkBaseTexture

      linkBaseTexture: boolean

      Protected onError

      onError: Runner

      Protected onResize

      onResize: Runner

      Protected onUpdate

      onUpdate: Runner

      Static SIDES

      SIDES: number

      Number of texture sides to store for CubeResources

      name

      PIXI.CubeResource.SIDES

      static
      member

      {number}

      @@ -41,7 +41,7 @@

      X dimension

    • height: number

      Y dimension

      -

    Returns void

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

    member

    {PIXI.BaseTexture}

    override

    Parameters

    • baseTexture: BaseTexture<Resource, IAutoDetectOptions>

    Returns void

update

  • update(): void

Returns ImageBasedLighting

Properties

Optional lookupBrdf

lookupBrdf?: Texture<Resource>

BRDF integration map lookup texture.

-

Static defaultLookupBrdf

defaultLookupBrdf: Texture<Resource> = ...
+

Static defaultLookupBrdf

defaultLookupBrdf: Texture<Resource> = ...

The default BRDF integration map lookup texture.

-

Accessors

diffuse

Accessors

diffuse

specular

specular

valid

  • get valid(): boolean

valid

  • get valid(): boolean

Legend

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

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/InstancedMesh3D.html b/docs/classes/InstancedMesh3D.html index 8c805fcc..6fb5af45 100644 --- a/docs/classes/InstancedMesh3D.html +++ b/docs/classes/InstancedMesh3D.html @@ -1,4 +1,4 @@ -InstancedMesh3D | Pixi3D - v1.1.1
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class InstancedMesh3D

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Optional _accessibleActive

_accessibleActive?: boolean

Optional _accessibleDiv

_accessibleDiv?: IAccessibleHTMLElement

_bounds

_bounds: Bounds

Protected _boundsID

_boundsID: number

Protected _boundsRect

_boundsRect: Rectangle

Optional _cacheAsBitmap

_cacheAsBitmap?: boolean

Optional _cacheAsBitmapResolution

_cacheAsBitmapResolution?: number

Optional _cacheData

_cacheData?: CacheData

Protected _destroyed

_destroyed: boolean

Protected _enabledFilters

_enabledFilters: Filter[]

Protected _height

_height: number

_lastSortedIndex

_lastSortedIndex: number

_localBounds

_localBounds: Bounds

Protected _localBoundsRect

_localBoundsRect: Rectangle

_mask

_mask: Container | MaskData

Optional _trackedPointers

_trackedPointers?: {}

Type declaration

  • [x: number]: InteractionTrackingData

Protected _width

_width: number

Protected _zIndex

_zIndex: number

Optional accessible

accessible?: boolean

Optional accessibleChildren

accessibleChildren?: true

Optional accessibleHint

accessibleHint?: string

Optional accessiblePointerEvents

accessiblePointerEvents?: PointerEvents

Optional accessibleTitle

accessibleTitle?: string

Optional accessibleType

accessibleType?: string

alpha

alpha: number

Optional buttonMode

buttonMode?: boolean

Optional cacheAsBitmap

cacheAsBitmap?: boolean

Optional cacheAsBitmapResolution

cacheAsBitmapResolution?: number

Readonly children

children: DisplayObject[]

containerUpdateTransform

containerUpdateTransform: () => void

Type declaration

    • (): void

    • Returns void

Optional cursor

cursor?: string

displayObjectUpdateTransform

displayObjectUpdateTransform: () => void

Type declaration

    • (): void

    • Returns void

filterArea

filterArea: Rectangle

filters

filters: Filter[]

Optional hitArea

hitArea?: IHitArea

Optional interactive

interactive?: boolean

Optional interactiveChildren

interactiveChildren?: boolean

isMask

isMask: boolean

isSprite

isSprite: boolean

Readonly material

material: unknown

Readonly mesh

mesh: Mesh3D

Optional name

name?: string

parent

parent: Container

Optional renderId

renderId?: number

renderable

renderable: boolean

sortDirty

sortDirty: boolean

sortableChildren

sortableChildren: boolean

Optional tabIndex

tabIndex?: number

Optional trackedPointers

trackedPointers?: {}

Type declaration

  • [x: number]: InteractionTrackingData

transform

transform: Transform3D = ...

visible

visible: boolean

worldAlpha

worldAlpha: number

Static prefixed

prefixed: string | boolean

Accessors

Protected _tempDisplayObjectParent

  • get _tempDisplayObjectParent(): TemporaryDisplayObject

localTransform

mask

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

    Parameters

    • value: number

    Returns void

localTransform

mask

  • get mask(): null | Container | MaskData
  • set mask(value: null | Container | 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 @@ -53,7 +53,7 @@

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

    since

    PixiJS 4

    member

    {PIXI.ObservablePoint}

    -

    Parameters

    • value: ObservablePoint<any>

    Returns void

position

rotation

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

    Parameters

    • value: ObservablePoint<any>

    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.

    member

    {number}

    @@ -61,9 +61,9 @@

    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.

    member

    {number}

    -

Parameters

  • value: number

Returns void

rotationQuaternion

  • +

    Parameters

    • value: number

    Returns void

rotationQuaternion

scale

skew

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

scale

skew

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

  • The skew factor for the object in radians.

    since

    PixiJS 4

    member

    {PIXI.ObservablePoint}

    @@ -77,7 +77,7 @@

    Returns number

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

    member

    {number}

    -

    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.

    member

    {boolean}

    readonly

    Returns boolean

x

  • get x(): number
  • set x(value: number): void
  • @@ -96,10 +96,10 @@

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

    member

    {number}

    -

    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
  • @@ -141,7 +141,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: DisplayObject): void

Returns InstancedModel

Properties

Optional _accessibleActive

_accessibleActive?: boolean

Optional _accessibleDiv

_accessibleDiv?: IAccessibleHTMLElement

_bounds

_bounds: Bounds

Protected _boundsID

_boundsID: number

Protected _boundsRect

_boundsRect: Rectangle

Optional _cacheAsBitmap

_cacheAsBitmap?: boolean

Optional _cacheAsBitmapResolution

_cacheAsBitmapResolution?: number

Optional _cacheData

_cacheData?: CacheData

Protected _destroyed

_destroyed: boolean

Protected _enabledFilters

_enabledFilters: Filter[]

Protected _height

_height: number

_lastSortedIndex

_lastSortedIndex: number

_localBounds

_localBounds: Bounds

Protected _localBoundsRect

_localBoundsRect: Rectangle

_mask

_mask: Container | MaskData

Optional _trackedPointers

_trackedPointers?: {}

Type declaration

  • [x: number]: InteractionTrackingData

Protected _width

_width: number

Protected _zIndex

_zIndex: number

Optional accessible

accessible?: boolean

Optional accessibleChildren

accessibleChildren?: true

Optional accessibleHint

accessibleHint?: string

Optional accessiblePointerEvents

accessiblePointerEvents?: PointerEvents

Optional accessibleTitle

accessibleTitle?: string

Optional accessibleType

accessibleType?: string

alpha

alpha: number

Optional buttonMode

buttonMode?: boolean

Optional cacheAsBitmap

cacheAsBitmap?: boolean

Optional cacheAsBitmapResolution

cacheAsBitmapResolution?: number

Readonly children

children: DisplayObject[]

containerUpdateTransform

containerUpdateTransform: () => void

Type declaration

    • (): void

    • Returns void

Optional cursor

cursor?: string

displayObjectUpdateTransform

displayObjectUpdateTransform: () => void

Type declaration

    • (): void

    • Returns void

filterArea

filterArea: Rectangle

filters

filters: Filter[]

Optional hitArea

hitArea?: IHitArea

Optional interactive

interactive?: boolean

Optional interactiveChildren

interactiveChildren?: boolean

isMask

isMask: boolean

isSprite

isSprite: boolean

meshes

meshes: InstancedMesh3D[] = []

The meshes included in the model.

-

Optional name

name?: string

parent

parent: Container

Optional renderId

renderId?: number

renderable

renderable: boolean

sortDirty

sortDirty: boolean

sortableChildren

sortableChildren: boolean

Optional tabIndex

tabIndex?: number

Optional trackedPointers

trackedPointers?: {}

Type declaration

  • [x: number]: InteractionTrackingData

transform

transform: Transform3D = ...

visible

visible: boolean

worldAlpha

worldAlpha: number

Static prefixed

prefixed: string | boolean

Accessors

Protected _tempDisplayObjectParent

  • get _tempDisplayObjectParent(): TemporaryDisplayObject
  • member

    {PIXI.Container}

    +

Optional name

name?: string

parent

parent: Container

Optional renderId

renderId?: number

renderable

renderable: boolean

sortDirty

sortDirty: boolean

sortableChildren

sortableChildren: boolean

Optional tabIndex

tabIndex?: number

Optional trackedPointers

trackedPointers?: {}

Type declaration

  • [x: number]: InteractionTrackingData

transform

transform: Transform3D = ...

visible

visible: boolean

worldAlpha

worldAlpha: number

Static prefixed

prefixed: string | boolean

Accessors

Protected _tempDisplayObjectParent

  • get _tempDisplayObjectParent(): TemporaryDisplayObject
  • member

    {PIXI.Container}

    Returns TemporaryDisplayObject

angle

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

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

    @@ -21,7 +21,7 @@

    Returns number

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

    member

    {number}

    -

    Parameters

    • value: number

    Returns void

localTransform

mask

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

    Parameters

    • value: number

    Returns void

localTransform

mask

  • get mask(): null | Container | MaskData
  • set mask(value: null | Container | 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 @@ -61,7 +61,7 @@

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

    since

    PixiJS 4

    member

    {PIXI.ObservablePoint}

    -

    Parameters

    • value: ObservablePoint<any>

    Returns void

position

rotation

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

    Parameters

    • value: ObservablePoint<any>

    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.

    member

    {number}

    @@ -69,9 +69,9 @@

    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.

    member

    {number}

    -

Parameters

Returns void

rotationQuaternion

  • +

    Parameters

    • value: number

    Returns void

rotationQuaternion

scale

skew

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

scale

skew

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

  • The skew factor for the object in radians.

    since

    PixiJS 4

    member

    {PIXI.ObservablePoint}

    @@ -85,7 +85,7 @@

    Returns number

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

    member

    {number}

    -

    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.

    member

    {boolean}

    readonly

    Returns boolean

x

  • get x(): number
  • set x(value: number): void
  • @@ -104,10 +104,10 @@

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

    member

    {number}

    -

    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.

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/Joint.html b/docs/classes/Joint.html index 52ef2bcc..198ef8ea 100644 --- a/docs/classes/Joint.html +++ b/docs/classes/Joint.html @@ -1,10 +1,10 @@ -Joint | Pixi3D - v1.1.1
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Joint

+Joint | Pixi3D - v1.1.2
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

Properties

Optional _accessibleActive

_accessibleActive?: boolean

Optional _accessibleDiv

_accessibleDiv?: IAccessibleHTMLElement

_bounds

_bounds: Bounds

Protected _boundsID

_boundsID: number

Protected _boundsRect

_boundsRect: Rectangle

Optional _cacheAsBitmap

_cacheAsBitmap?: boolean

Optional _cacheAsBitmapResolution

_cacheAsBitmapResolution?: number

Optional _cacheData

_cacheData?: CacheData

Protected _destroyed

_destroyed: boolean

Protected _enabledFilters

_enabledFilters: Filter[]

Protected _height

_height: number

_lastSortedIndex

_lastSortedIndex: number

_localBounds

_localBounds: Bounds

Protected _localBoundsRect

_localBoundsRect: Rectangle

_mask

_mask: Container | MaskData

Optional _trackedPointers

_trackedPointers?: {}

Type declaration

  • [x: number]: InteractionTrackingData

Protected _width

_width: number

Protected _zIndex

_zIndex: number

Optional accessible

accessible?: boolean

Optional accessibleChildren

accessibleChildren?: true

Optional accessibleHint

accessibleHint?: string

Optional accessiblePointerEvents

accessiblePointerEvents?: PointerEvents

Optional accessibleTitle

accessibleTitle?: string

Optional accessibleType

accessibleType?: string

alpha

alpha: number

Optional buttonMode

buttonMode?: boolean

Optional cacheAsBitmap

cacheAsBitmap?: boolean

Optional cacheAsBitmapResolution

cacheAsBitmapResolution?: number

Readonly children

children: DisplayObject[]

containerUpdateTransform

containerUpdateTransform: () => void

Type declaration

    • (): void

    • Returns void

Optional cursor

cursor?: string

displayObjectUpdateTransform

displayObjectUpdateTransform: () => void

Type declaration

    • (): void

    • Returns void

filterArea

filterArea: Rectangle

filters

filters: Filter[]

Optional hitArea

hitArea?: IHitArea

Optional interactive

interactive?: boolean

Optional interactiveChildren

interactiveChildren?: boolean

Readonly inverseBindMatrix

inverseBindMatrix: Float32Array

isMask

isMask: boolean

isSprite

isSprite: boolean

Optional name

name?: string

parent

parent: Container

Optional renderId

renderId?: number

renderable

renderable: boolean

sortDirty

sortDirty: boolean

sortableChildren

sortableChildren: boolean

Optional tabIndex

tabIndex?: number

Optional trackedPointers

trackedPointers?: {}

Type declaration

  • [x: number]: InteractionTrackingData

transform

transform: Transform3D = ...

visible

visible: boolean

worldAlpha

worldAlpha: number

Static prefixed

prefixed: string | boolean

Accessors

Protected _tempDisplayObjectParent

  • get _tempDisplayObjectParent(): TemporaryDisplayObject
  • member

    {PIXI.Container}

    +

Returns Joint

Properties

Optional _accessibleActive

_accessibleActive?: boolean

Optional _accessibleDiv

_accessibleDiv?: IAccessibleHTMLElement

_bounds

_bounds: Bounds

Protected _boundsID

_boundsID: number

Protected _boundsRect

_boundsRect: Rectangle

Optional _cacheAsBitmap

_cacheAsBitmap?: boolean

Optional _cacheAsBitmapResolution

_cacheAsBitmapResolution?: number

Optional _cacheData

_cacheData?: CacheData

Protected _destroyed

_destroyed: boolean

Protected _enabledFilters

_enabledFilters: Filter[]

Protected _height

_height: number

_lastSortedIndex

_lastSortedIndex: number

_localBounds

_localBounds: Bounds

Protected _localBoundsRect

_localBoundsRect: Rectangle

_mask

_mask: Container | MaskData

Optional _trackedPointers

_trackedPointers?: {}

Type declaration

  • [x: number]: InteractionTrackingData

Protected _width

_width: number

Protected _zIndex

_zIndex: number

Optional accessible

accessible?: boolean

Optional accessibleChildren

accessibleChildren?: true

Optional accessibleHint

accessibleHint?: string

Optional accessiblePointerEvents

accessiblePointerEvents?: PointerEvents

Optional accessibleTitle

accessibleTitle?: string

Optional accessibleType

accessibleType?: string

alpha

alpha: number

Optional buttonMode

buttonMode?: boolean

Optional cacheAsBitmap

cacheAsBitmap?: boolean

Optional cacheAsBitmapResolution

cacheAsBitmapResolution?: number

Readonly children

children: DisplayObject[]

containerUpdateTransform

containerUpdateTransform: () => void

Type declaration

    • (): void

    • Returns void

Optional cursor

cursor?: string

displayObjectUpdateTransform

displayObjectUpdateTransform: () => void

Type declaration

    • (): void

    • Returns void

filterArea

filterArea: Rectangle

filters

filters: Filter[]

Optional hitArea

hitArea?: IHitArea

Optional interactive

interactive?: boolean

Optional interactiveChildren

interactiveChildren?: boolean

Readonly inverseBindMatrix

inverseBindMatrix: Float32Array

isMask

isMask: boolean

isSprite

isSprite: boolean

Optional name

name?: string

parent

parent: Container

Optional renderId

renderId?: number

renderable

renderable: boolean

sortDirty

sortDirty: boolean

sortableChildren

sortableChildren: boolean

Optional tabIndex

tabIndex?: number

Optional trackedPointers

trackedPointers?: {}

Type declaration

  • [x: number]: InteractionTrackingData

transform

transform: Transform3D = ...

visible

visible: boolean

worldAlpha

worldAlpha: number

Static prefixed

prefixed: string | boolean

Accessors

Protected _tempDisplayObjectParent

  • get _tempDisplayObjectParent(): TemporaryDisplayObject
  • member

    {PIXI.Container}

    Returns TemporaryDisplayObject

angle

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

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

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

    Returns number

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

    member

    {number}

    -

    Parameters

    • value: number

    Returns void

localTransform

mask

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

    Parameters

    • value: number

    Returns void

localTransform

mask

  • get mask(): null | Container | MaskData
  • set mask(value: null | Container | 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 @@ -59,7 +59,7 @@

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

    since

    PixiJS 4

    member

    {PIXI.ObservablePoint}

    -

    Parameters

    • value: ObservablePoint<any>

    Returns void

position

rotation

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

    Parameters

    • value: ObservablePoint<any>

    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.

    member

    {number}

    @@ -67,9 +67,9 @@

    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.

    member

    {number}

    -

Parameters

  • value: number

Returns void

rotationQuaternion

  • +

    Parameters

    • value: number

    Returns void

rotationQuaternion

scale

skew

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

scale

skew

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

  • The skew factor for the object in radians.

    since

    PixiJS 4

    member

    {PIXI.ObservablePoint}

    @@ -83,7 +83,7 @@

    Returns number

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

    member

    {number}

    -

    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.

    member

    {boolean}

    readonly

    Returns boolean

x

  • get x(): number
  • set x(value: number): void
  • @@ -102,10 +102,10 @@

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

    member

    {number}

    -

    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

rotationQuaternion

  • +

    Parameters

    • value: number

    Returns void

rotationQuaternion

scale

skew

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

scale

skew

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

  • The skew factor for the object in radians.

    since

    PixiJS 4

    member

    {PIXI.ObservablePoint}

    @@ -89,7 +89,7 @@

    Returns number

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

    member

    {number}

    -

    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.

    member

    {boolean}

    readonly

    Returns boolean

x

  • get x(): number
  • set x(value: number): void
  • @@ -108,10 +108,10 @@

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

    member

    {number}

    -

    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

Generated using TypeDoc

\ No newline at end of file +

Returns boolean

Methods

destroy

  • destroy(): void

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/Mat4.html b/docs/classes/Mat4.html index 235d6292..77e494f0 100644 --- a/docs/classes/Mat4.html +++ b/docs/classes/Mat4.html @@ -1 +1 @@ -Mat4 | Pixi3D - v1.1.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

Generated using TypeDoc

\ No newline at end of file +Mat4 | Pixi3D - v1.1.2
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

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/Material.html b/docs/classes/Material.html index 3073e4c5..20a4eb18 100644 --- a/docs/classes/Material.html +++ b/docs/classes/Material.html @@ -1,49 +1,49 @@ -Material | Pixi3D - v1.1.1
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Material

+Material | Pixi3D - v1.1.2
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

Abstract createShader

Abstract 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 Abstract updateUniforms

Returns void

Optional Abstract updateUniforms

Properties

Optional clearColor

clearColor?: Color = ...

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

name

name: string

The name of the render pass.

-

renderer

renderer: Renderer

Accessors

renderTexture

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

renderer

renderer: Renderer

Accessors

renderTexture

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

Methods

clear

  • clear(): void

Methods

clear

  • clear(): void

render

  • render(meshes: Mesh3D[]): void

render

  • render(meshes: Mesh3D[]): void

Legend

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

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/Matrix4.html b/docs/classes/Matrix4.html index 529497d8..1bc4ffb4 100644 --- a/docs/classes/Matrix4.html +++ b/docs/classes/Matrix4.html @@ -1,29 +1,29 @@ -Matrix4 | Pixi3D - v1.1.1
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Matrix4

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

Class Matrix4

Represents a 4x4 matrix.

-

Hierarchy

  • Matrix
    • Matrix4

Implements

  • TransformId

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

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

Hierarchy

  • Matrix
    • Matrix4

Implements

  • TransformId

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

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

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

    Parameters

    • Optional array: ArrayLike<number>

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

      -

    Returns Matrix4

Properties

a

a: number

array

array: Float32Array
+

Returns Matrix4

Properties

a

a: number

array

array: Float32Array

The array containing the matrix data.

-

b

b: number

c

c: number

d

d: number

tx

tx: number

ty

ty: number

Accessors

backward

  • get backward(): Float32Array

b

b: number

c

c: number

d

d: number

tx

tx: number

ty

ty: number

Accessors

backward

  • get backward(): Float32Array

down

  • get down(): Float32Array

down

  • get down(): Float32Array

forward

  • get forward(): Float32Array

forward

  • get forward(): Float32Array

left

  • get left(): Float32Array

left

  • get left(): Float32Array

position

  • get position(): Float32Array

position

  • get position(): Float32Array

right

  • get right(): Float32Array

right

  • get right(): Float32Array

rotation

  • get rotation(): Float32Array

rotation

  • get rotation(): Float32Array

scaling

  • get scaling(): Float32Array

scaling

  • get scaling(): Float32Array

transformId

  • get transformId(): number

up

  • get up(): Float32Array

transformId

  • get transformId(): number

up

  • get up(): Float32Array

Static IDENTITY

  • get IDENTITY(): Matrix

  • A default (identity) matrix

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

      @@ -77,7 +77,7 @@

invert

  • Inverts this matrix

    Returns Matrix4

    This matrix. Good for chaining method calls.

    -

multiply

multiply

  • Multiplies this matrix with another matrix.

    Parameters

    • matrix: Matrix4

      The matrix to multiply with.

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

      Matrix component

    Returns Matrix4

    This matrix. Good for chaining method calls.

    -

setFromRotationPositionScale

setFromRotationPositionScale

toArray

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

  • Parameters

    • transpose: boolean
    • Optional out: Float32Array

    Returns Float32Array

toString

  • toString(): string

  • Returns string

translate

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

toArray

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

  • Parameters

    • transpose: boolean
    • Optional out: Float32Array

    Returns Float32Array

toString

  • toString(): string

  • Returns string

translate

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

Properties

Optional _accessibleActive

_accessibleActive?: boolean

Optional _accessibleDiv

_accessibleDiv?: IAccessibleHTMLElement

_bounds

_bounds: Bounds

Protected _boundsID

_boundsID: number

Protected _boundsRect

_boundsRect: Rectangle

Optional _cacheAsBitmap

_cacheAsBitmap?: boolean

Optional _cacheAsBitmapResolution

_cacheAsBitmapResolution?: number

Optional _cacheData

_cacheData?: CacheData

Protected _destroyed

_destroyed: boolean

Protected _enabledFilters

_enabledFilters: Filter[]

Protected _height

_height: number

_lastSortedIndex

_lastSortedIndex: number

_localBounds

_localBounds: Bounds

Protected _localBoundsRect

_localBoundsRect: Rectangle

_mask

_mask: Container | MaskData

Optional _trackedPointers

_trackedPointers?: {}

Type declaration

  • [x: number]: InteractionTrackingData

Protected _width

_width: number

Protected _zIndex

_zIndex: number

Optional accessible

accessible?: boolean

Optional accessibleChildren

accessibleChildren?: true

Optional accessibleHint

accessibleHint?: string

Optional accessiblePointerEvents

accessiblePointerEvents?: PointerEvents

Optional accessibleTitle

accessibleTitle?: string

Optional accessibleType

accessibleType?: string

alpha

alpha: number

Optional buttonMode

buttonMode?: boolean

Optional cacheAsBitmap

cacheAsBitmap?: boolean

Optional cacheAsBitmapResolution

cacheAsBitmapResolution?: number

Readonly children

children: DisplayObject[]

containerUpdateTransform

containerUpdateTransform: () => void

Type declaration

    • (): void

    • Returns void

Optional cursor

cursor?: string

displayObjectUpdateTransform

displayObjectUpdateTransform: () => void

Type declaration

    • (): void

    • Returns void

enabledRenderPasses

enabledRenderPasses: {} = ...

The enabled render passes for this mesh.

-

Type declaration

  • [name: string]: unknown

filterArea

filterArea: Rectangle

filters

filters: Filter[]

geometry

geometry: MeshGeometry3D

Optional hitArea

hitArea?: IHitArea

Optional interactive

interactive?: boolean

Optional interactiveChildren

interactiveChildren?: boolean

isMask

isMask: boolean

isSprite

isSprite: boolean

Optional material

material?: Material

Optional name

name?: string

parent

parent: Container

pluginName

pluginName: string = "pipeline"
+

Type declaration

  • [name: string]: unknown

filterArea

filterArea: Rectangle

filters

filters: Filter[]

geometry

geometry: MeshGeometry3D

Optional hitArea

hitArea?: IHitArea

Optional interactive

interactive?: boolean

Optional interactiveChildren

interactiveChildren?: boolean

isMask

isMask: boolean

isSprite

isSprite: boolean

Optional material

material?: Material

Optional name

name?: string

parent

parent: Container

pluginName

pluginName: string = "pipeline"

The name of the plugin used for rendering the mesh.

-

Optional renderId

renderId?: number

renderSortOrder

renderSortOrder: number = 0
+

Optional renderId

renderId?: number

renderSortOrder

renderSortOrder: number = 0

Used for sorting the mesh before render.

-

renderable

renderable: boolean

Optional skin

skin?: Skin
+

renderable

renderable: boolean

Optional skin

skin?: Skin

The skin used for vertex skinning.

-

sortDirty

sortDirty: boolean

sortableChildren

sortableChildren: boolean

Optional tabIndex

tabIndex?: number

Optional targetWeights

targetWeights?: number[]
+

sortDirty

sortDirty: boolean

sortableChildren

sortableChildren: boolean

Optional tabIndex

tabIndex?: number

Optional targetWeights

targetWeights?: number[]

Array of weights used for morphing between geometry targets.

-

Optional trackedPointers

trackedPointers?: {}

Type declaration

  • [x: number]: InteractionTrackingData

transform

transform: Transform3D = ...

visible

visible: boolean

worldAlpha

worldAlpha: number

Static prefixed

prefixed: string | boolean

Accessors

Protected _tempDisplayObjectParent

  • get _tempDisplayObjectParent(): TemporaryDisplayObject
  • member

    {PIXI.Container}

    +

Optional trackedPointers

trackedPointers?: {}

Type declaration

  • [x: number]: InteractionTrackingData

transform

transform: Transform3D = ...

visible

visible: boolean

worldAlpha

worldAlpha: number

Static prefixed

prefixed: string | boolean

Accessors

Protected _tempDisplayObjectParent

  • get _tempDisplayObjectParent(): TemporaryDisplayObject
  • member

    {PIXI.Container}

    Returns TemporaryDisplayObject

angle

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

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

    @@ -31,9 +31,9 @@

    Returns number

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

    member

    {number}

    -

    Parameters

    • value: number

    Returns void

instances

instances

localTransform

mask

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

    Returns InstancedMesh3D[]

localTransform

mask

  • get mask(): null | Container | MaskData
  • set mask(value: null | Container | 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 @@ -73,7 +73,7 @@

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

    since

    PixiJS 4

    member

    {PIXI.ObservablePoint}

    -

    Parameters

    • value: ObservablePoint<any>

    Returns void

position

rotation

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

    Parameters

    • value: ObservablePoint<any>

    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.

    member

    {number}

    @@ -81,9 +81,9 @@

    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.

    member

    {number}

    -

Parameters

  • value: number

Returns void

rotationQuaternion

  • +

    Parameters

    • value: number

    Returns void

rotationQuaternion

scale

skew

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

scale

skew

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

  • The skew factor for the object in radians.

    since

    PixiJS 4

    member

    {PIXI.ObservablePoint}

    @@ -97,7 +97,7 @@

    Returns number

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

    member

    {number}

    -

    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.

    member

    {boolean}

    readonly

    Returns boolean

x

  • get x(): number
  • set x(value: number): void
  • @@ -116,10 +116,10 @@

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

    member

    {number}

    -

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

    Returns void

Optional _calculateCachedBounds

  • _calculateCachedBounds(): void

Optional _destroyCachedDisplayObject

  • _destroyCachedDisplayObject(): void

Optional _getCachedLocalBounds

  • _getCachedLocalBounds(): Rectangle

Optional _initCachedDisplayObject

  • _initCachedDisplayObject(renderer: Renderer): void

Optional _initCachedDisplayObjectCanvas

  • _initCachedDisplayObjectCanvas(renderer: CanvasRenderer): 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

Optional _renderCached

  • _renderCached(renderer: Renderer): void

  • Parameters

    • renderer: Renderer

    Returns void

Optional _renderCachedCanvas

  • _renderCachedCanvas(renderer: CanvasRenderer): void

  • Parameters

    • renderer: CanvasRenderer

    Returns void

addChild

  • addChild<T>(...children: T): T[0]

  • Adds one or more children to the container.

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

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

      @@ -226,7 +226,7 @@

      Calling getLocalBounds may invalidate the _bounds of the whole subtree below. If using it inside a render() call, it is advised to call getBounds() immediately after to recalculate the world bounds of the subtree.

      Parameters

      • Optional rect: Rectangle
      • Optional skipChildrenUpdate: boolean

      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.

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

removeChildren

  • removeChildren(beginIndex?: number, endIndex?: number): DisplayObject[]

  • Removes all children from this container that are within the begin and end indexes.

    Parameters

    • Optional beginIndex: number
    • Optional endIndex: number

    Returns DisplayObject[]

    List of removed children

    -

removeInstance

removeInstance

  • Removes an instance from this mesh.

    Parameters

    • instance: InstancedMesh3D

      The instance to remove.

      @@ -316,15 +316,15 @@
    • Optional from: DisplayObject
    • Optional point: P
    • Optional skipUpdate: boolean

    Returns P

    A point object representing the position of this object

updateTransform

  • updateTransform(): void

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

    -

    Returns void

Static createCube

Static createCube

Static createPlane

Returns Mesh3D

Static createPlane

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

    Parameters

    • material: Material = ...

      The material to use.

      -

    Returns Mesh3D

Static createQuad

Returns Mesh3D

Static createQuad

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 bcd5bcf4..11fb9a14 100644 --- a/docs/classes/MeshShader.html +++ b/docs/classes/MeshShader.html @@ -1,17 +1,17 @@ -MeshShader | Pixi3D - v1.1.1
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Class MeshShader

      +MeshShader | Pixi3D - v1.1.2
      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
        • Optional uniforms: Dict<any>

        Returns MeshShader

      Properties

      program

      program: Program

      uniformGroup

      uniformGroup: UniformGroup

      Accessors

      name

      • get name(): string

      Hierarchy

      • Shader
        • MeshShader

      Index

      Constructors

      Properties

      Accessors

      Methods

      Constructors

      constructor

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

      • Parameters

        • program: Program
        • Optional uniforms: Dict<any>

        Returns MeshShader

      Properties

      program

      program: Program

      uniformGroup

      uniformGroup: UniformGroup

      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
        member

        {object}

        -

        Returns Dict<any>

      Methods

      checkUniformExists

      • checkUniformExists(name: string, group: UniformGroup): boolean

      • Parameters

        • name: string
        • group: UniformGroup

        Returns boolean

      createShaderGeometry

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

      Methods

      checkUniformExists

      • checkUniformExists(name: string, group: UniformGroup): boolean

      • Parameters

        • name: string
        • group: UniformGroup

        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

Accessors

Protected _tempDisplayObjectParent

  • get _tempDisplayObjectParent(): TemporaryDisplayObject
  • member

    {PIXI.Container}

    Returns TemporaryDisplayObject

angle

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

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

    @@ -20,7 +20,7 @@

    Returns number

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

    member

    {number}

    -

    Parameters

    • value: number

    Returns void

localTransform

mask

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

    Parameters

    • value: number

    Returns void

localTransform

mask

  • get mask(): null | Container | MaskData
  • set mask(value: null | Container | 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 @@ -60,7 +60,7 @@

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

    since

    PixiJS 4

    member

    {PIXI.ObservablePoint}

    -

    Parameters

    • value: ObservablePoint<any>

    Returns void

position

rotation

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

    Parameters

    • value: ObservablePoint<any>

    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.

    member

    {number}

    @@ -68,9 +68,9 @@

    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.

    member

    {number}

    -

Parameters

Returns void

rotationQuaternion

  • +

    Parameters

    • value: number

    Returns void

rotationQuaternion

scale

skew

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

scale

skew

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

  • The skew factor for the object in radians.

    since

    PixiJS 4

    member

    {PIXI.ObservablePoint}

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

    Returns number

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

    member

    {number}

    -

    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.

    member

    {boolean}

    readonly

    Returns boolean

x

  • get x(): number
  • set x(value: number): void
  • @@ -103,10 +103,10 @@

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

    member

    {number}

    -

    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
  • @@ -148,7 +148,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. @@ -288,7 +288,7 @@

  • Optional from: DisplayObject
  • Optional point: P
  • Optional skipUpdate: boolean

Returns P

A point object representing the position of this object

updateTransform

  • updateTransform(): void

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

    -

    Returns void

Static from

Static from

  • Creates a new model from a source.

    Parameters

    • source: glTFAsset

      The source to create the model from.

      diff --git a/docs/classes/ObservablePoint3D.html b/docs/classes/ObservablePoint3D.html index 0246af2e..69d5cb00 100644 --- a/docs/classes/ObservablePoint3D.html +++ b/docs/classes/ObservablePoint3D.html @@ -1,6 +1,6 @@ -ObservablePoint3D | Pixi3D - v1.1.1
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Class ObservablePoint3D

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

      Class ObservablePoint3D

      Represents a point in 3D space.

      -

      Hierarchy

      • ObservablePoint
        • ObservablePoint3D

      Index

      Constructors

      Properties

      Accessors

      Methods

      Constructors

      constructor

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

      Hierarchy

      • ObservablePoint
        • ObservablePoint3D

      Index

      Constructors

      Properties

      Accessors

      Methods

      Constructors

      constructor

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

      • Creates a new observable point.

        Parameters

        • cb: () => void

          The callback when changed.

          @@ -12,23 +12,23 @@

          The position on the y axis.

        • z: number = 0

          The position on the z axis.

          -

        Returns ObservablePoint3D

      Properties

      _x

      _x: number

      _y

      _y: number

      cb

      cb: () => any

      Type declaration

        • (): any

        • Returns any

      scope

      scope: any

      Accessors

      array

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

      Returns ObservablePoint3D

Properties

_x

_x: number

_y

_y: number

cb

cb: () => any

Type declaration

    • (): any

    • Returns any

scope

scope: any

Accessors

array

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

x

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

x

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

y

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

y

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

z

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

z

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

Methods

clone

copyFrom

copyTo

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

equals

set

Methods

clone

copyFrom

copyTo

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

equals

set

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

    Parameters

    • x: number

      The position on the x axis.

      @@ -36,7 +36,7 @@

      The position on the y axis.

    • z: number = x

      The position on the z axis.

      -

    Returns ObservablePoint3D

setFrom

Returns ObservablePoint3D

setFrom

Properties

_x

_x: number

_y

_y: number

cb

cb: () => any

Type declaration

    • (): any

    • Returns any

scope

scope: any

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

copyFrom

Returns ObservableQuaternion

copyFrom

copyTo

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

Returns ObservableQuaternion

copyTo

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

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

    Type parameters

    • T: IPoint<T>

    Parameters

    • p: T

      The quaternion to copy to.

      -

    Returns T

equals

Returns T

equals

set

Returns boolean

set

setEulerAngles

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

Returns ObservableQuaternion

setEulerAngles

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

setFrom

Returns void

setFrom

Properties

Optional camera

camera?: Camera

id

id: Uint8Array = ...

The id which maps to the object.

-

object

object: Mesh3D | Model

Methods

contains

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

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 318877d3..31e514b8 100644 --- a/docs/classes/PickingInteraction.html +++ b/docs/classes/PickingInteraction.html @@ -1,13 +1,13 @@ -PickingInteraction | Pixi3D - v1.1.1
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PickingInteraction

+PickingInteraction | Pixi3D - v1.1.2
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

Methods

containsHitArea

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

Returns PickingInteraction

Properties

renderer

renderer: Renderer

Methods

containsHitArea

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

destroy

  • destroy(): void

Legend

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

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Returns boolean

destroy

  • destroy(): void

Generated using TypeDoc

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

Class Plane

Hierarchy

  • Plane

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

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

Properties

distance

distance: number

Accessors

normal

  • get normal(): Float32Array

Methods

rayCast

  • rayCast(ray: Ray): number

Generated using TypeDoc

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

Class Plane

Hierarchy

  • Plane

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

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

Properties

distance

distance: number

Accessors

normal

  • get normal(): Float32Array

Methods

rayCast

  • rayCast(ray: Ray): number

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/PostProcessingSprite.html b/docs/classes/PostProcessingSprite.html index 2b3b294d..58aa6582 100644 --- a/docs/classes/PostProcessingSprite.html +++ b/docs/classes/PostProcessingSprite.html @@ -1,7 +1,7 @@ -PostProcessingSprite | Pixi3D - v1.1.1
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PostProcessingSprite

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

Class PostProcessingSprite

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

-

Hierarchy

  • Sprite
    • PostProcessingSprite

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Hierarchy

  • Sprite
    • PostProcessingSprite

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

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

    Parameters

    • renderer: Renderer

      The renderer to use.

      @@ -37,7 +37,7 @@

      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.

      member

      {number}

      -

      Parameters

      • value: number

      Returns void

depthTexture

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

depthTexture

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

height

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

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

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

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

    since

    PixiJS 4

    member

    {PIXI.ObservablePoint}

    -

    Parameters

    • value: ObservablePoint<any>

    Returns void

renderTexture

  • get renderTexture(): RenderTexture

renderTexture

  • get renderTexture(): RenderTexture

rotation

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

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

    Parameters

    • point: IPointData

      the point to test

    Returns boolean

    the result of the test

    -

destroy

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

disableTempParent

  • disableTempParent(cacheParent: DisplayObject): void
  • +

destroy

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

disableTempParent

  • disableTempParent(cacheParent: DisplayObject): void

  • Pair method for enableTempParent

    Parameters

    • cacheParent: DisplayObject

      Actual parent of element

      @@ -333,7 +333,7 @@

      Render the object using the WebGL renderer and advanced features.

      Parameters

      • renderer: Renderer

        The renderer

        -

      Returns void

Optional renderCanvas

  • renderCanvas(renderer: CanvasRenderer): void

  • Parameters

    • renderer: CanvasRenderer

    Returns void

renderObject

  • renderObject(object: DisplayObject): void

Returns void

Optional renderCanvas

  • renderCanvas(renderer: CanvasRenderer): void

  • Parameters

    • renderer: CanvasRenderer

    Returns void

renderObject

  • renderObject(object: DisplayObject): void

Properties

Optional camera

camera?: Camera

The camera to follow when using directional lights.

-

followCamera

followCamera: boolean = true
+

followCamera

followCamera: boolean = true

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

-

light

light: Light

renderer

renderer: Renderer

shadowArea

shadowArea: number = 50
+

light

light: Light

renderer

renderer: Renderer

shadowArea

shadowArea: number = 50

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

-

softness

softness: number = 0
+

softness

softness: number = 0

The softness of the edges for the shadow.

-

Accessors

filterTexture

  • get filterTexture(): RenderTexture

Accessors

filterTexture

  • get filterTexture(): RenderTexture

lightViewProjection

  • get lightViewProjection(): Float32Array

lightViewProjection

  • get lightViewProjection(): Float32Array

shadowTexture

  • get shadowTexture(): RenderTexture

shadowTexture

  • get shadowTexture(): RenderTexture

Methods

clear

  • clear(): void

Methods

clear

  • clear(): void

destroy

  • destroy(): void

destroy

  • destroy(): void

updateLightViewProjection

  • updateLightViewProjection(): void

updateLightViewProjection

  • updateLightViewProjection(): void

Static isHighQualitySupported

  • isHighQualitySupported(renderer: Renderer): boolean

Static isHighQualitySupported

  • isHighQualitySupported(renderer: Renderer): boolean

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

    Parameters

    • renderer: Renderer

      The renderer to use.

      -

    Returns boolean

Static isMediumQualitySupported

  • isMediumQualitySupported(renderer: Renderer): boolean

Returns boolean

Static isMediumQualitySupported

  • isMediumQualitySupported(renderer: Renderer): boolean

clear

  • clear(): void

removeShadowCastingLight

removeShadowCastingLight

render

  • render(meshes: Mesh3D[]): void

Returns void

render

  • render(meshes: Mesh3D[]): void

Legend

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

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/Skin.html b/docs/classes/Skin.html index 94754354..20ad6730 100644 --- a/docs/classes/Skin.html +++ b/docs/classes/Skin.html @@ -1,15 +1,15 @@ -Skin | Pixi3D - v1.1.1
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Skin

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

Class Skin

Represents a skin used for vertex skinning.

-

Hierarchy

  • Skin

Index

Constructors

Properties

Methods

Constructors

constructor

Hierarchy

  • Skin

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

jointMatrices

jointMatrices: Float32Array = ...
+

Returns Skin

Properties

jointMatrices

jointMatrices: Float32Array = ...

The joint matrices which has been calculated.

-

jointNormalMatrices

jointNormalMatrices: Float32Array = ...
+

jointNormalMatrices

jointNormalMatrices: Float32Array = ...

The joint normal matrices which has been calculated.

-

Readonly joints

joints: Joint[]

Readonly parent

parent: Container3D

Methods

calculateJointMatrices

  • calculateJointMatrices(): void

Readonly joints

joints: Joint[]

Readonly parent

parent: Container3D

Methods

calculateJointMatrices

  • calculateJointMatrices(): void

Legend

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

Settings

Theme

Generated using TypeDoc

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

Class Skybox

+Skybox | Pixi3D - v1.1.2
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

Properties

Optional _accessibleActive

_accessibleActive?: boolean

Optional _accessibleDiv

_accessibleDiv?: IAccessibleHTMLElement

_bounds

_bounds: Bounds

Protected _boundsID

_boundsID: number

Protected _boundsRect

_boundsRect: Rectangle

Optional _cacheAsBitmap

_cacheAsBitmap?: boolean

Optional _cacheAsBitmapResolution

_cacheAsBitmapResolution?: number

Optional _cacheData

_cacheData?: CacheData

Protected _destroyed

_destroyed: boolean

Protected _enabledFilters

_enabledFilters: Filter[]

Protected _height

_height: number

_lastSortedIndex

_lastSortedIndex: number

_localBounds

_localBounds: Bounds

Protected _localBoundsRect

_localBoundsRect: Rectangle

_mask

_mask: Container | MaskData

Optional _trackedPointers

_trackedPointers?: {}

Type declaration

  • [x: number]: InteractionTrackingData

Protected _width

_width: number

Protected _zIndex

_zIndex: number

Optional accessible

accessible?: boolean

Optional accessibleChildren

accessibleChildren?: true

Optional accessibleHint

accessibleHint?: string

Optional accessiblePointerEvents

accessiblePointerEvents?: PointerEvents

Optional accessibleTitle

accessibleTitle?: string

Optional accessibleType

accessibleType?: string

alpha

alpha: number

Optional buttonMode

buttonMode?: boolean

Optional cacheAsBitmap

cacheAsBitmap?: boolean

Optional cacheAsBitmapResolution

cacheAsBitmapResolution?: number

Readonly children

children: DisplayObject[]

containerUpdateTransform

containerUpdateTransform: () => void

Type declaration

    • (): void

    • Returns void

Optional cursor

cursor?: string

displayObjectUpdateTransform

displayObjectUpdateTransform: () => void

Type declaration

    • (): void

    • Returns void

filterArea

filterArea: Rectangle

filters

filters: Filter[]

Optional hitArea

hitArea?: IHitArea

Optional interactive

interactive?: boolean

Optional interactiveChildren

interactiveChildren?: boolean

isMask

isMask: boolean

isSprite

isSprite: boolean

Optional name

name?: string

parent

parent: Container

Optional renderId

renderId?: number

renderable

renderable: boolean

sortDirty

sortDirty: boolean

sortableChildren

sortableChildren: boolean

Optional tabIndex

tabIndex?: number

Optional trackedPointers

trackedPointers?: {}

Type declaration

  • [x: number]: InteractionTrackingData

transform

transform: Transform3D = ...

visible

visible: boolean

worldAlpha

worldAlpha: number

Static prefixed

prefixed: string | boolean

Accessors

Protected _tempDisplayObjectParent

  • get _tempDisplayObjectParent(): TemporaryDisplayObject
  • member

    {PIXI.Container}

    +

Returns Skybox

Properties

Optional _accessibleActive

_accessibleActive?: boolean

Optional _accessibleDiv

_accessibleDiv?: IAccessibleHTMLElement

_bounds

_bounds: Bounds

Protected _boundsID

_boundsID: number

Protected _boundsRect

_boundsRect: Rectangle

Optional _cacheAsBitmap

_cacheAsBitmap?: boolean

Optional _cacheAsBitmapResolution

_cacheAsBitmapResolution?: number

Optional _cacheData

_cacheData?: CacheData

Protected _destroyed

_destroyed: boolean

Protected _enabledFilters

_enabledFilters: Filter[]

Protected _height

_height: number

_lastSortedIndex

_lastSortedIndex: number

_localBounds

_localBounds: Bounds

Protected _localBoundsRect

_localBoundsRect: Rectangle

_mask

_mask: Container | MaskData

Optional _trackedPointers

_trackedPointers?: {}

Type declaration

  • [x: number]: InteractionTrackingData

Protected _width

_width: number

Protected _zIndex

_zIndex: number

Optional accessible

accessible?: boolean

Optional accessibleChildren

accessibleChildren?: true

Optional accessibleHint

accessibleHint?: string

Optional accessiblePointerEvents

accessiblePointerEvents?: PointerEvents

Optional accessibleTitle

accessibleTitle?: string

Optional accessibleType

accessibleType?: string

alpha

alpha: number

Optional buttonMode

buttonMode?: boolean

Optional cacheAsBitmap

cacheAsBitmap?: boolean

Optional cacheAsBitmapResolution

cacheAsBitmapResolution?: number

Readonly children

children: DisplayObject[]

containerUpdateTransform

containerUpdateTransform: () => void

Type declaration

    • (): void

    • Returns void

Optional cursor

cursor?: string

displayObjectUpdateTransform

displayObjectUpdateTransform: () => void

Type declaration

    • (): void

    • Returns void

filterArea

filterArea: Rectangle

filters

filters: Filter[]

Optional hitArea

hitArea?: IHitArea

Optional interactive

interactive?: boolean

Optional interactiveChildren

interactiveChildren?: boolean

isMask

isMask: boolean

isSprite

isSprite: boolean

Optional name

name?: string

parent

parent: Container

Optional renderId

renderId?: number

renderable

renderable: boolean

sortDirty

sortDirty: boolean

sortableChildren

sortableChildren: boolean

Optional tabIndex

tabIndex?: number

Optional trackedPointers

trackedPointers?: {}

Type declaration

  • [x: number]: InteractionTrackingData

transform

transform: Transform3D = ...

visible

visible: boolean

worldAlpha

worldAlpha: number

Static prefixed

prefixed: string | boolean

Accessors

Protected _tempDisplayObjectParent

  • get _tempDisplayObjectParent(): TemporaryDisplayObject
  • member

    {PIXI.Container}

    Returns TemporaryDisplayObject

angle

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

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

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

    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.

    member

    {number}

    -

    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

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

    @@ -31,7 +31,7 @@

    Returns number

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

    member

    {number}

    -

    Parameters

    • value: number

    Returns void

localTransform

mask

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

    Parameters

    • value: number

    Returns void

localTransform

mask

  • get mask(): null | Container | MaskData
  • set mask(value: null | Container | 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 @@ -71,7 +71,7 @@

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

    since

    PixiJS 4

    member

    {PIXI.ObservablePoint}

    -

    Parameters

    • value: ObservablePoint<any>

    Returns void

position

rotation

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

    Parameters

    • value: ObservablePoint<any>

    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.

    member

    {number}

    @@ -79,9 +79,9 @@

    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.

    member

    {number}

    -

Parameters

  • value: number

Returns void

rotationQuaternion

  • +

    Parameters

    • value: number

    Returns void

rotationQuaternion

scale

skew

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

scale

skew

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

  • The skew factor for the object in radians.

    since

    PixiJS 4

    member

    {PIXI.ObservablePoint}

    @@ -95,7 +95,7 @@

    Returns number

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

    member

    {number}

    -

    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.

    member

    {boolean}

    readonly

    Returns boolean

x

  • get x(): number
  • set x(value: number): void
  • @@ -114,10 +114,10 @@

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

    member

    {number}

    -

    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
  • @@ -297,7 +297,7 @@
  • Optional from: DisplayObject
  • Optional point: P
  • Optional skipUpdate: boolean

Returns P

A point object representing the position of this object

updateTransform

  • updateTransform(): void

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

    -

    Returns void

Static from

Static from

Properties

Optional _accessibleActive

_accessibleActive?: boolean

Optional _accessibleDiv

_accessibleDiv?: IAccessibleHTMLElement

_bounds

_bounds: Bounds

Protected _boundsID

_boundsID: number

Protected _boundsRect

_boundsRect: Rectangle

Optional _cacheAsBitmap

_cacheAsBitmap?: boolean

Optional _cacheAsBitmapResolution

_cacheAsBitmapResolution?: number

Optional _cacheData

_cacheData?: CacheData

Protected _destroyed

_destroyed: boolean

Protected _enabledFilters

_enabledFilters: Filter[]

Protected _height

_height: number

_lastSortedIndex

_lastSortedIndex: number

_localBounds

_localBounds: Bounds

Protected _localBoundsRect

_localBoundsRect: Rectangle

_mask

_mask: Container | MaskData

Optional _trackedPointers

_trackedPointers?: {}

Type declaration

  • [x: number]: InteractionTrackingData

Protected _width

_width: number

Protected _zIndex

_zIndex: number

Optional accessible

accessible?: boolean

Optional accessibleChildren

accessibleChildren?: true

Optional accessibleHint

accessibleHint?: string

Optional accessiblePointerEvents

accessiblePointerEvents?: PointerEvents

Optional accessibleTitle

accessibleTitle?: string

Optional accessibleType

accessibleType?: string

alpha

alpha: number

Optional buttonMode

buttonMode?: boolean

Optional cacheAsBitmap

cacheAsBitmap?: boolean

Optional cacheAsBitmapResolution

cacheAsBitmapResolution?: number

Optional camera

camera?: Camera

The camera used when rendering the sprite. Uses main camera by default.

-

Readonly children

children: DisplayObject[]

containerUpdateTransform

containerUpdateTransform: () => void

Type declaration

    • (): void

    • Returns void

Optional cursor

cursor?: string

displayObjectUpdateTransform

displayObjectUpdateTransform: () => void

Type declaration

    • (): void

    • Returns void

filterArea

filterArea: Rectangle

filters

filters: Filter[]

Optional hitArea

hitArea?: IHitArea

Optional interactive

interactive?: boolean

Optional interactiveChildren

interactiveChildren?: boolean

isMask

isMask: boolean

isSprite

isSprite: boolean

Optional name

name?: string

parent

parent: Container

Optional renderId

renderId?: number

renderable

renderable: boolean

sortDirty

sortDirty: boolean

sortableChildren

sortableChildren: boolean

Optional tabIndex

tabIndex?: number

Optional trackedPointers

trackedPointers?: {}

Type declaration

  • [x: number]: InteractionTrackingData

transform

transform: Transform3D = ...

visible

visible: boolean

worldAlpha

worldAlpha: number

Static prefixed

prefixed: string | boolean

Accessors

Protected _tempDisplayObjectParent

  • get _tempDisplayObjectParent(): TemporaryDisplayObject
  • member

    {PIXI.Container}

    -

    Returns TemporaryDisplayObject

anchor

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

Readonly children

children: DisplayObject[]

containerUpdateTransform

containerUpdateTransform: () => void

Type declaration

    • (): void

    • Returns void

Optional cursor

cursor?: string

displayObjectUpdateTransform

displayObjectUpdateTransform: () => void

Type declaration

    • (): void

    • Returns void

filterArea

filterArea: Rectangle

filters

filters: Filter[]

Optional hitArea

hitArea?: IHitArea

Optional interactive

interactive?: boolean

Optional interactiveChildren

interactiveChildren?: boolean

isMask

isMask: boolean

isSprite

isSprite: boolean

Optional name

name?: string

parent

parent: Container

Optional renderId

renderId?: number

renderable

renderable: boolean

sortDirty

sortDirty: boolean

sortableChildren

sortableChildren: boolean

Optional tabIndex

tabIndex?: number

Optional trackedPointers

trackedPointers?: {}

Type declaration

  • [x: number]: InteractionTrackingData

transform

transform: Transform3D = ...

visible

visible: boolean

worldAlpha

worldAlpha: number

Static prefixed

prefixed: string | boolean

Accessors

Protected _tempDisplayObjectParent

  • get _tempDisplayObjectParent(): TemporaryDisplayObject
  • member

    {PIXI.Container}

    +

    Returns TemporaryDisplayObject

anchor

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

angle

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

  • The angle of the object in degrees. @@ -19,15 +19,15 @@

    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.

    member

    {number}

    -

    Parameters

    • value: number

    Returns void

billboardType

billboardType

blendMode

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

blendMode

  • get blendMode(): BLEND_MODES
  • set blendMode(value: BLEND_MODES): 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

    @@ -35,7 +35,7 @@

    Returns number

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

    member

    {number}

    -

    Parameters

    • value: number

    Returns void

localTransform

mask

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

    Parameters

    • value: number

    Returns void

localTransform

mask

  • get mask(): null | Container | MaskData
  • set mask(value: null | Container | 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 @@ -75,11 +75,11 @@

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

    since

    PixiJS 4

    member

    {PIXI.ObservablePoint}

    -

    Parameters

    • value: ObservablePoint<any>

    Returns void

pixelsPerUnit

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

pixelsPerUnit

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

position

rotation

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

    Parameters

    • value: number

    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.

    member

    {number}

    @@ -87,9 +87,9 @@

    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.

    member

    {number}

    -

Parameters

  • value: number

Returns void

rotationQuaternion

  • +

    Parameters

    • value: number

    Returns void

rotationQuaternion

scale

skew

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

scale

skew

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

  • The skew factor for the object in radians.

    since

    PixiJS 4

    member

    {PIXI.ObservablePoint}

    @@ -97,14 +97,14 @@

    The skew factor for the object in radians.

    since

    PixiJS 4

    member

    {PIXI.ObservablePoint}

    -

Parameters

Returns void

texture

  • get texture(): Texture<Resource>
  • set texture(value: Texture<Resource>): void

texture

  • get texture(): Texture<Resource>
  • set texture(value: Texture<Resource>): void

tint

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

tint

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

  • The tint applied to the sprite. This is a hex value. A value of 0xFFFFFF will remove any tint effect.

    -

    Returns number

  • +

    Returns number

  • The tint applied to the sprite. This is a hex value. A value of 0xFFFFFF will remove any tint effect.

    Parameters

    • value: number

    Returns void

width

  • get width(): number
  • set width(value: number): void
  • @@ -113,7 +113,7 @@

    Returns number

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

    member

    {number}

    -

    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.

    member

    {boolean}

    readonly

    Returns boolean

x

  • get x(): number
  • set x(value: number): void
  • @@ -132,10 +132,10 @@

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

    member

    {number}

    -

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

    Returns void

Optional _calculateCachedBounds

  • _calculateCachedBounds(): void

Optional _destroyCachedDisplayObject

  • _destroyCachedDisplayObject(): void

Optional _getCachedLocalBounds

  • _getCachedLocalBounds(): Rectangle

Optional _initCachedDisplayObject

  • _initCachedDisplayObject(renderer: Renderer): void

Optional _initCachedDisplayObjectCanvas

  • _initCachedDisplayObjectCanvas(renderer: CanvasRenderer): 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

  • Renders the sprite.

    Parameters

    • renderer: Renderer

      The renderer to use.

      @@ -179,7 +179,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?: boolean | IDestroyOptions): void

destroy

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

disableTempParent

  • disableTempParent(cacheParent: DisplayObject): void

  • Pair method for enableTempParent

    diff --git a/docs/classes/SpriteBatchRenderer.html b/docs/classes/SpriteBatchRenderer.html index 023df780..2554eadb 100644 --- a/docs/classes/SpriteBatchRenderer.html +++ b/docs/classes/SpriteBatchRenderer.html @@ -1,4 +1,4 @@ -SpriteBatchRenderer | Pixi3D - v1.1.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class SpriteBatchRenderer

    Hierarchy

    • AbstractBatchRenderer
      • SpriteBatchRenderer

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    Properties

    MAX_TEXTURES

    MAX_TEXTURES: number

    Protected _aBuffers

    _aBuffers: ViewableBuffer[]

    Protected _aIndex

    _aIndex: number

    Protected _attributeBuffer

    _attributeBuffer: ViewableBuffer

    Protected _bufferSize

    _bufferSize: number

    Protected _bufferedElements

    _bufferedElements: IBatchableElement[]

    Protected _bufferedTextures

    _bufferedTextures: BaseTexture<Resource, IAutoDetectOptions>[]

    Protected _dcIndex

    _dcIndex: number

    Protected _flushId

    _flushId: number

    Protected _iBuffers

    _iBuffers: Uint16Array[]

    Protected _iIndex

    _iIndex: number

    Protected _indexBuffer

    _indexBuffer: Uint16Array

    Protected _indexCount

    _indexCount: number

    Protected _shader

    _shader: Shader

    Protected _tempBoundTextures

    _tempBoundTextures: BaseTexture<Resource, IAutoDetectOptions>[]

    Protected _vertexCount

    _vertexCount: number

    Protected geometryClass

    geometryClass: typeof BatchGeometry

    Protected renderer

    renderer: Renderer

    Protected shaderGenerator

    shaderGenerator: BatchShaderGenerator

    size

    size: number

    Readonly state

    state: State

    Protected vertexSize

    vertexSize: number

    Static _drawCallPool

    _drawCallPool: BatchDrawCall[]
    +SpriteBatchRenderer | Pixi3D - v1.1.2
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class SpriteBatchRenderer

    Hierarchy

    • AbstractBatchRenderer
      • SpriteBatchRenderer

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    Properties

    MAX_TEXTURES

    MAX_TEXTURES: number

    Protected _aBuffers

    _aBuffers: ViewableBuffer[]

    Protected _aIndex

    _aIndex: number

    Protected _attributeBuffer

    _attributeBuffer: ViewableBuffer

    Protected _bufferSize

    _bufferSize: number

    Protected _bufferedElements

    _bufferedElements: IBatchableElement[]

    Protected _bufferedTextures

    _bufferedTextures: BaseTexture<Resource, IAutoDetectOptions>[]

    Protected _dcIndex

    _dcIndex: number

    Protected _flushId

    _flushId: number

    Protected _iBuffers

    _iBuffers: Uint16Array[]

    Protected _iIndex

    _iIndex: number

    Protected _indexBuffer

    _indexBuffer: Uint16Array

    Protected _indexCount

    _indexCount: number

    Protected _shader

    _shader: Shader

    Protected _tempBoundTextures

    _tempBoundTextures: BaseTexture<Resource, IAutoDetectOptions>[]

    Protected _vertexCount

    _vertexCount: number

    Protected geometryClass

    geometryClass: typeof BatchGeometry

    Protected renderer

    renderer: Renderer

    Protected shaderGenerator

    shaderGenerator: BatchShaderGenerator

    size

    size: number

    Readonly state

    state: State

    Protected vertexSize

    vertexSize: number

    Static _drawCallPool

    _drawCallPool: BatchDrawCall[]

    Pool of BatchDrawCall objects that flush used to create "batches" of the objects being rendered.

    These are never re-allocated again. @@ -30,7 +30,7 @@

    Handles the prerender signal.

    It ensures that flushes start from the first geometry object again.

    -

    Returns void

packInterleavedGeometry

  • packInterleavedGeometry(element: IBatchableElement, attributeBuffer: ViewableBuffer, indexBuffer: Uint16Array, aIndex: number, iIndex: number): void

  • Parameters

    • element: IBatchableElement
    • attributeBuffer: ViewableBuffer
    • indexBuffer: Uint16Array
    • aIndex: number
    • iIndex: number

    Returns void

render

  • render(element: IBatchableElement): void
  • +

    Returns void

packInterleavedGeometry

  • packInterleavedGeometry(element: IBatchableElement, attributeBuffer: ViewableBuffer, indexBuffer: Uint16Array, aIndex: number, iIndex: number): void

  • Parameters

    • element: IBatchableElement
    • attributeBuffer: ViewableBuffer
    • indexBuffer: Uint16Array
    • aIndex: number
    • iIndex: number

    Returns void

render

  • render(element: IBatchableElement): void

Properties

_frame

_frame: Rectangle

Protected _rotate

_rotate: number

_updateID

_updateID: number

_uvs

_uvs: TextureUvs

baseTexture

baseTexture: BaseTexture<Resource, IAutoDetectOptions>

defaultAnchor

defaultAnchor: Point

noFrame

noFrame: boolean

orig

orig: Rectangle

Optional patternCache

patternCache?: {}

Type declaration

  • [key: string]: CanvasPattern

Optional strength

strength?: number

textureCacheIds

textureCacheIds: string[]

Optional tintCache

tintCache?: {}

Type declaration

  • [key: string]: HTMLCanvasElement | HTMLImageElement

Optional transform

transform?: TextureTransform

The transform to use for this texture.

trim

trim: Rectangle

uvMatrix

uvMatrix: TextureMatrix

Optional uvSet

uvSet?: number

valid

valid: boolean

Static Readonly EMPTY

EMPTY: Texture<CanvasResource>

Static Readonly WHITE

WHITE: Texture<CanvasResource>

Static prefixed

prefixed: string | boolean

Accessors

frame

  • get frame(): Rectangle
  • set frame(frame: Rectangle): void

Returns StandardMaterialTexture

Properties

_frame

_frame: Rectangle

Protected _rotate

_rotate: number

_updateID

_updateID: number

_uvs

_uvs: TextureUvs

baseTexture

baseTexture: BaseTexture<Resource, IAutoDetectOptions>

defaultAnchor

defaultAnchor: Point

noFrame

noFrame: boolean

orig

orig: Rectangle

Optional patternCache

patternCache?: {}

Type declaration

  • [key: string]: CanvasPattern

textureCacheIds

textureCacheIds: string[]

Optional tintCache

tintCache?: {}

Type declaration

  • [key: string]: HTMLCanvasElement | HTMLImageElement

Optional transform

transform?: TextureTransform

The transform to use for this texture.

trim

trim: Rectangle

uvMatrix

uvMatrix: TextureMatrix

Optional uvSet

uvSet?: number

valid

valid: boolean

Static Readonly EMPTY

EMPTY: Texture<CanvasResource>

Static Readonly WHITE

WHITE: Texture<CanvasResource>

Static prefixed

prefixed: string | boolean

Accessors

frame

  • get frame(): Rectangle
  • set frame(frame: Rectangle): void

Returns StandardPipeline

Properties

materialPass

materialPass: MaterialRenderPass = ...

The pass used for rendering materials.

-

renderPasses

renderPasses: RenderPass[] = ...
+

renderPasses

renderPasses: RenderPass[] = ...

The array of render passes. Each mesh will be rendered with these passes (if it has been enabled on that mesh).

-

renderer

renderer: Renderer

shadowPass

shadowPass: ShadowRenderPass = ...
+

renderer

renderer: Renderer

shadowPass

shadowPass: ShadowRenderPass = ...

The pass used for rendering shadows.

-

Methods

createPostProcessingSprite

Methods

createPostProcessingSprite

destroy

  • destroy(): void

  • Generic destruction method that frees all resources. This should be called by subclasses.

    -

    Returns void

disableShadows

disableShadows

enableShadows

Returns void

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.

    @@ -32,13 +32,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

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 84d7935a..0f126103 100644 --- a/docs/classes/Vec3.html +++ b/docs/classes/Vec3.html @@ -1 +1 @@ -Vec3 | Pixi3D - v1.1.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 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 subtract

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

      • Parameters

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

        Returns Float32Array

      Static transformMat4

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

      • Parameters

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

        Returns Float32Array

      Static transformQuat

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

      • Parameters

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

        Returns Float32Array

      Legend

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

      Settings

      Theme

      Generated using TypeDoc

      \ No newline at end of file +Vec3 | Pixi3D - v1.1.2
      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 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 subtract

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

      • Parameters

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

        Returns Float32Array

      Static transformMat4

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

      • Parameters

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

        Returns Float32Array

      Static transformQuat

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

      • Parameters

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

        Returns Float32Array

      Legend

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

      Settings

      Theme

      Generated using TypeDoc

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

      Class glTFAsset

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

      Class glTFAsset

      glTF assets are JSON files plus supporting external data.

      -

      Hierarchy

      • glTFAsset

      Index

      Constructors

      Properties

      Methods

      Constructors

      constructor

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

      Hierarchy

      • glTFAsset

      Index

      Constructors

      Properties

      Methods

      Constructors

      constructor

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

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

        Parameters

        • descriptor: any

          The JSON descriptor to create the asset from.

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

          The buffers used by this asset.

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

          The images used by this asset.

          -

        Returns glTFAsset

      Properties

      Readonly buffers

      buffers: ArrayBuffer[] = []

      Readonly descriptor

      descriptor: any

      Readonly images

      images: Texture<Resource>[] = []

      Methods

      Static fromBuffer

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

      Returns glTFAsset

Properties

Readonly buffers

buffers: ArrayBuffer[] = []

Readonly descriptor

descriptor: any

Readonly images

images: Texture<Resource>[] = []

Methods

Static fromBuffer

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

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

    Parameters

    • data: ArrayBuffer

      The binary buffer data to read from.

    • cb: (gltf: glTFAsset) => void

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

      -

    Returns void

Static isEmbeddedResource

  • isEmbeddedResource(uri: string): boolean

Returns void

Static isEmbeddedResource

  • isEmbeddedResource(uri: string): boolean

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

    Parameters

    • uri: string

      The uri to check.

      -

    Returns boolean

Static isValidBuffer

  • isValidBuffer(buffer: ArrayBuffer): boolean

Returns boolean

Static isValidBuffer

  • isValidBuffer(buffer: ArrayBuffer): boolean

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

    Parameters

    • buffer: ArrayBuffer

      The buffer data to validate.

      -

    Returns boolean

Static load

Returns boolean

Static load