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
+
Parameters
value: null | Container | MaskData
Returns void
near
get near(): number
set near(value: number): void
The near clipping plane distance, 0.1 is the default value.
-
Returns number
+
Returns number
The near clipping plane distance, 0.1 is the default value.
-
Parameters
value: number
Returns void
obliqueness
get obliqueness(): IPointData
set obliqueness(value: IPointData): void
+
Parameters
value: number
Returns 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
+
Parameters
value: IPointData
Returns void
orthographic
get orthographic(): boolean
set orthographic(value: boolean): void
Camera will render objects uniformly, with no sense of perspective.
-
Returns boolean
+
Returns boolean
Camera will render objects uniformly, with no sense of perspective.
-
Parameters
value: boolean
Returns void
orthographicSize
get orthographicSize(): number
set orthographicSize(value: number): void
+
Parameters
value: boolean
Returns 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.
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.
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 @@
Collection of components used for image-based lighting (IBL), a
rendering technique which involves capturing an omnidirectional representation
of real-world light information as an image.
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 @@
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.
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 @@
- Preparing search index...
- The search index is not available
Pixi3D - v1.1.2Class Animation
Represents an animation.
-Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Hierarchy
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
Returns Animation
Properties
Readonly Abstract duration
The duration (in seconds) of this animation.
-loop
loop
A value indicating if the animation is looping.
-Optional name
Abstract position
Optional name
Abstract position
The current position (in seconds) of this animation.
-speed
speed
The speed that the animation will play at.
Static prefixed
Methods
add
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Animation
emit
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
Add a one-time listener for a given event.
-Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Animation
play
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Animation
play
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
remove
Remove the listeners of a given event.
-Parameters
event: string | symbol
Optional fn: ListenerFn
Optional context: any
Optional once: boolean
Returns Animation
stop
Parameters
event: string | symbol
Optional fn: ListenerFn
Optional context: any
Optional once: boolean
Returns Animation
stop
Stops playing the animation.
-Returns void
update
Returns void
update
Updates the animation by the specified delta time.
Parameters
delta: number
The time in seconds since last frame.
diff --git a/docs/classes/Camera.html b/docs/classes/Camera.html index 5269cf8b..cd1f1e49 100644 --- a/docs/classes/Camera.html +++ b/docs/classes/Camera.html @@ -1,11 +1,11 @@ -- Preparing search index...
- The search index is not available
Pixi3D - v1.1.1Class Camera
- Preparing search index...
- The search index is not available
Pixi3D - v1.1.2Class Camera
Camera is a device from which the world is viewed.
-Hierarchy
Implements
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Hierarchy
Implements
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Creates a new camera using the specified renderer. By default the camera looks towards negative z and is positioned at z = 5.
Parameters
renderer: Renderer
Renderer to use.
-Returns Camera
Properties
Optional _accessible
Optional _accessible
_bounds
Protected _boundsID
Protected _bounds
Optional _cache
Optional _cache
Optional _cache
Protected _destroyed
Protected _enabled
Protected _height
_last
_local
Protected _local
_mask
Optional _tracked
Type declaration
[x: number]: InteractionTrackingData
Protected _width
Protected _z
Optional accessible
Optional accessible
Optional accessible
Optional accessible
Optional accessible
Optional accessible
alpha
Optional button
Optional cache
Optional cache
Readonly children
container
Type declaration
Returns void
Optional cursor
display
Type declaration
Returns void
filter
filters
Optional hit
Optional interactive
Optional interactive
is
is
Optional name
parent
Optional render
renderable
renderer
sort
sortable
Optional tab
Optional tracked
Type declaration
[x: number]: InteractionTrackingData
transform
visible
world
Static main
Returns Camera
Properties
Optional _accessible
Optional _accessible
_bounds
Protected _boundsID
Protected _bounds
Optional _cache
Optional _cache
Optional _cache
Protected _destroyed
Protected _enabled
Protected _height
_last
_local
Protected _local
_mask
Optional _tracked
Type declaration
[x: number]: InteractionTrackingData
Protected _width
Protected _z
Optional accessible
Optional accessible
Optional accessible
Optional accessible
Optional accessible
Optional accessible
alpha
Optional button
Optional cache
Optional cache
Readonly children
container
Type declaration
Returns void
Optional cursor
display
Type declaration
Returns void
filter
filters
Optional hit
Optional interactive
Optional interactive
is
is
Optional name
parent
Optional render
renderable
renderer
sort
sortable
Optional tab
Optional tracked
Type declaration
[x: number]: InteractionTrackingData
transform
visible
world
Static main
Main camera which is used by default.
Static prefixed
Accessors
Protected _temp
{PIXI.Container}
Returns TemporaryDisplayObject
angle
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.
{number}
-Parameters
value: number
Returns void
aspect
Parameters
value: number
Returns void
aspect
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
Parameters
value: undefined | number
Returns void
far
The far clipping plane distance, 1000 is the default value.
-Returns number
Returns number
The far clipping plane distance, 1000 is the default value.
-Parameters
value: number
Returns void
field
Parameters
value: number
Returns void
field
The vertical field of view in degrees, 60 is the default value.
-Returns number
Returns number
The vertical field of view in degrees, 60 is the default value.
Parameters
value: number
Returns void
height
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
{number}
-Parameters
value: number
Returns void
local
Returns Matrix4
mask
Parameters
value: number
Returns void
local
Returns Matrix4
mask
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;
At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.
{PIXI.Container|PIXI.MaskData|null}
-Parameters
value: null | Container | MaskData
Returns void
near
Parameters
value: null | Container | MaskData
Returns void
near
The near clipping plane distance, 0.1 is the default value.
-Returns number
Returns number
The near clipping plane distance, 0.1 is the default value.
-Parameters
value: number
Returns void
obliqueness
Parameters
value: number
Returns void
obliqueness
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
Parameters
value: IPointData
Returns void
orthographic
Camera will render objects uniformly, with no sense of perspective.
-Returns boolean
Returns boolean
Camera will render objects uniformly, with no sense of perspective.
-Parameters
value: boolean
Returns void
orthographic
Parameters
value: boolean
Returns void
orthographic
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
By default, the pivot is the origin (0, 0).
PixiJS 4
{PIXI.ObservablePoint}
-Parameters
value: ObservablePoint<any>
Returns void
position
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
projection
Parameters
value: ObservablePoint<any>
Returns void
position
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
projection
Returns the projection matrix.
Returns Float32Array
rotation
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.
{number}
-Parameters
value: number
Returns void
rotation
Parameters
value: number
Returns void
rotation
The quaternion rotation of the object.
-Returns ObservableQuaternion
Parameters
value: ObservableQuaternion
Returns void
scale
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
skew
Returns ObservableQuaternion
Parameters
value: ObservableQuaternion
Returns void
scale
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
skew
The skew factor for the object in radians.
PixiJS 4
{PIXI.ObservablePoint}
@@ -118,9 +118,9 @@The skew factor for the object in radians.
PixiJS 4
{PIXI.ObservablePoint}
-Parameters
value: ObservablePoint<any>
Returns void
transform
Returns number
view
Parameters
value: ObservablePoint<any>
Returns void
transform
Returns number
view
Returns the view matrix.
-Returns Float32Array
view
Returns Float32Array
view
Returns the view projection matrix.
Returns Float32Array
width
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
{number}
-Parameters
value: number
Returns void
world
Returns Matrix4
world
Parameters
value: number
Returns void
world
Returns Matrix4
world
Indicates if the object is globally visible.
{boolean}
Returns boolean
x
The position of the displayObject on the y axis relative to the local coordinates of the parent. An alias to position.y
{number}
-Parameters
value: number
Returns void
z
Parameters
value: number
Returns void
z
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
z
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
Returns void
destroy
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
disable
Render the object using the WebGL renderer and advanced features.
Parameters
renderer: Renderer
The renderer
-Returns void
Optional render
Parameters
renderer: CanvasRenderer
Returns void
screen
Returns void
Optional render
Parameters
renderer: CanvasRenderer
Returns void
screen
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
screen
height: number
width: number
Returns undefined | Ray
screen
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
update
Updates the transform on all children of this container for rendering
-Returns void
world
Returns void
world
Converts world coordinates to screen coordinates.
Parameters
x: number
World x coordinate.
diff --git a/docs/classes/CameraOrbitControl.html b/docs/classes/CameraOrbitControl.html index 3ef90560..7e3578e9 100644 --- a/docs/classes/CameraOrbitControl.html +++ b/docs/classes/CameraOrbitControl.html @@ -1,23 +1,23 @@ -- Preparing search index...
- The search index is not available
Pixi3D - v1.1.1Class CameraOrbitControl
- Preparing search index...
- The search index is not available
Pixi3D - v1.1.2Class CameraOrbitControl
Allows the user to control the camera by orbiting the target.
-Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Creates a new camera orbit control.
Parameters
element: HTMLElement
The element for listening to user events.
camera: Camera = Camera.main
The camera to control. If not set, the main camera will be used by default.
-Returns CameraOrbitControl
Properties
allow
Returns CameraOrbitControl
Properties
allow
Allows the camera to be controlled by user.
-camera
target
camera
target
Target position (x, y, z) to orbit.
-Type declaration
x: number
y: number
z: number
Accessors
angles
Type declaration
x: number
y: number
z: number
Accessors
angles
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
Returns ObservablePoint<undefined>
distance
Distance between camera and the target. Default value is 5.
-Returns number
Returns number
Distance between camera and the target. Default value is 5.
-Parameters
value: number
Returns void
Methods
update
Parameters
value: number
Returns void
Methods
update
Updates the position and rotation of the camera.
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
Pixi3D - v1.1.1Class Color
- Preparing search index...
- The search index is not available
Pixi3D - v1.1.2Class Color
Represents a color containing RGBA components.
-Hierarchy
Index
Constructors
Accessors
Methods
Constructors
constructor
Hierarchy
Index
Constructors
Accessors
Methods
Constructors
constructor
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
Returns Color
Accessors
a
The A (alpha) component.
-Returns number
Returns number
The A (alpha) component.
-Parameters
value: number
Returns void
b
Parameters
value: number
Returns void
b
The B (blue) component.
-Returns number
Returns number
The B (blue) component.
-Parameters
value: number
Returns void
g
Parameters
value: number
Returns void
g
The G (green) component.
-Returns number
Returns number
The G (green) component.
-Parameters
value: number
Returns void
r
Parameters
value: number
Returns void
r
The R (red) component.
-Returns number
Returns number
The R (red) component.
-Parameters
value: number
Returns void
rgb
Parameters
value: number
Returns void
rgb
The color as an typed array containing RGB.
-Returns Float32Array
rgba
Returns Float32Array
rgba
The color as an typed array containing RGBA.
-Returns Float32Array
Methods
Static from
Returns Float32Array
Methods
Static from
Creates a new color from the specified source.
Parameters
source: Float32Array | number[]
The source to create the color from.
-Returns Color
Static from
Returns Color
Static from
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 from
Returns Color
Static from
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 @@ -- Preparing search index...
- The search index is not available
Pixi3D - v1.1.1Class Container3D
- Preparing search index...
- The search index is not available
Pixi3D - v1.1.2Class Container3D
A container represents a collection of 3D objects.
-Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Returns Container3D
Properties
Optional _accessible
Optional _accessible
_bounds
Protected _boundsID
Protected _bounds
Optional _cache
Optional _cache
Optional _cache
Protected _destroyed
Protected _enabled
Protected _height
_last
_local
Protected _local
_mask
Optional _tracked
Type declaration
[x: number]: InteractionTrackingData
Protected _width
Protected _z
Optional accessible
Optional accessible
Optional accessible
Optional accessible
Optional accessible
Optional accessible
alpha
Optional button
Optional cache
Optional cache
Readonly children
container
Type declaration
Returns void
Optional cursor
display
Type declaration
Returns void
filter
filters
Optional hit
Optional interactive
Optional interactive
is
is
Optional name
parent
Optional render
renderable
sort
sortable
Optional tab
Optional tracked
Type declaration
[x: number]: InteractionTrackingData
transform
visible
world
Static prefixed
Accessors
Protected _temp
{PIXI.Container}
+Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Returns Container3D
Properties
Optional _accessible
Optional _accessible
_bounds
Protected _boundsID
Protected _bounds
Optional _cache
Optional _cache
Optional _cache
Protected _destroyed
Protected _enabled
Protected _height
_last
_local
Protected _local
_mask
Optional _tracked
Type declaration
[x: number]: InteractionTrackingData
Protected _width
Protected _z
Optional accessible
Optional accessible
Optional accessible
Optional accessible
Optional accessible
Optional accessible
alpha
Optional button
Optional cache
Optional cache
Readonly children
container
Type declaration
Returns void
Optional cursor
display
Type declaration
Returns void
filter
filters
Optional hit
Optional interactive
Optional interactive
is
is
Optional name
parent
Optional render
renderable
sort
sortable
Optional tab
Optional tracked
Type declaration
[x: number]: InteractionTrackingData
transform
visible
world
Static prefixed
Accessors
Protected _temp
{PIXI.Container}
Returns TemporaryDisplayObject
angle
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
{number}
-Parameters
value: number
Returns void
local
Returns Matrix4
mask
Parameters
value: number
Returns void
local
Returns Matrix4
mask
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).
PixiJS 4
{PIXI.ObservablePoint}
-Parameters
value: ObservablePoint<any>
Returns void
position
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
rotation
Parameters
value: ObservablePoint<any>
Returns void
position
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
rotation
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.
{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.
{number}
-Parameters
value: number
Returns void
rotation
Parameters
value: number
Returns void
rotation
The quaternion rotation of the object.
-Returns ObservableQuaternion
Parameters
value: ObservableQuaternion
Returns void
scale
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
skew
Returns ObservableQuaternion
Parameters
value: ObservableQuaternion
Returns void
scale
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
skew
The skew factor for the object in radians.
PixiJS 4
{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
{number}
-Parameters
value: number
Returns void
world
Returns Matrix4
world
Parameters
value: number
Returns void
world
Returns Matrix4
world
Indicates if the object is globally visible.
{boolean}
Returns boolean
x
The position of the displayObject on the y axis relative to the local coordinates of the parent. An alias to position.y
{number}
-Parameters
value: number
Returns void
z
Parameters
value: number
Returns void
z
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
z
- Preparing search index...
- The search index is not available
Pixi3D - v1.1.1Class Cubemap
- Preparing search index...
- The search index is not available
Pixi3D - v1.1.2Class Cubemap
Cubemap which supports multiple user specified mipmaps.
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
Optional resource: any
Optional options: IBaseTextureOptions<IAutoDetectOptions>
Returns Cubemap
Properties
_batch
_batch
_gl
Type declaration
[key: number]: GLTexture
Optional alpha
Optional anisotropic
cache
destroyed
dirty
dirty
Optional format
height
is
Optional mipmap
parent
resolution
resource
Optional scale
Optional target
texture
touched
Optional type
Readonly uid
valid
width
Optional wrap
Static _global
Global number of the texture batch, used by multi-texture renderers
{number}
-Static prefixed
Accessors
levels
Static prefixed
Accessors
levels
Returns the number of mipmap levels.
Returns number
real
Pixel height of the source of this texture
@@ -11,7 +11,7 @@Returns number
real
Pixel width of the source of this texture
{number}
-Returns number
Static faces
Returns number
Static faces
Returns an array of faces.
Returns ["posx", "negx", "posy", "negy", "posz", "negz"]
Methods
add
Parameters
event: string | symbol
fn: ListenerFn
Optional context: any
Returns Cubemap
cast
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 from
Static from
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 from
Returns Cubemap
Static from
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 @@ -- Preparing search index...
- The search index is not available
Pixi3D - v1.1.1Class CubemapResource
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
source: MipmapResourceArray
levels: number = 1
Returns CubemapResource
Properties
Protected _height
Protected _width
base
destroyed
internal
item
items
Readonly length
levels
link
Protected on
Protected on
Protected on
Static SIDES
- Preparing search index...
- The search index is not available
Pixi3D - v1.1.2Class CubemapResource
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
source: MipmapResourceArray
levels: number = 1
Returns CubemapResource
Properties
Protected _height
Protected _width
base
destroyed
internal
item
items
Readonly length
levels
link
Protected on
Protected on
Protected on
Static SIDES
Number of texture sides to store for CubeResources
PIXI.CubeResource.SIDES
{number}
@@ -41,7 +41,7 @@X dimension
height: number
Y dimension
-Returns void
style
Parameters
renderer: Renderer
Returns boolean
unbind
Returns void
style
Parameters
renderer: Renderer
Returns boolean
unbind
Unset the parent base texture
{PIXI.BaseTexture}
Parameters
baseTexture: BaseTexture<Resource, IAutoDetectOptions>
Returns void
update
- Preparing search index...
- The search index is not available
Pixi3D - v1.1.1Class ImageBasedLighting
- Preparing search index...
- The search index is not available
Pixi3D - v1.1.2Class ImageBasedLighting
Collection of components used for image-based lighting (IBL), a rendering technique which involves capturing an omnidirectional representation of real-world light information as an image.
-Hierarchy
Index
Constructors
Properties
Accessors
Constructors
constructor
Hierarchy
Index
Constructors
Properties
Accessors
Constructors
constructor
Creates a new image-based lighting object.
Parameters
diffuse: Cubemap
Cubemap used for the diffuse component.
specular: Cubemap
Cubemap used for the specular component.
-Returns ImageBasedLighting
Properties
Optional lookup
Returns ImageBasedLighting
Properties
Optional lookup
BRDF integration map lookup texture.
-Static default
Static default
The default BRDF integration map lookup texture.
-Accessors
diffuse
Accessors
diffuse
Cube texture used for the diffuse component.
-Returns Cubemap
specular
Returns Cubemap
specular
Cube mipmap texture used for the specular component.
-Returns Cubemap
valid
Returns Cubemap
valid
Value indicating if this object is valid to be used for rendering.
Returns boolean
Generated using TypeDoc
- Preparing search index...
- The search index is not available
Pixi3D - v1.1.1Class InstancedMesh3D
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
mesh: Mesh3D
material: unknown
Returns InstancedMesh3D
Properties
Optional _accessible
Optional _accessible
_bounds
Protected _boundsID
Protected _bounds
Optional _cache
Optional _cache
Optional _cache
Protected _destroyed
Protected _enabled
Protected _height
_last
_local
Protected _local
_mask
Optional _tracked
Type declaration
[x: number]: InteractionTrackingData
Protected _width
Protected _z
Optional accessible
Optional accessible
Optional accessible
Optional accessible
Optional accessible
Optional accessible
alpha
Optional button
Optional cache
Optional cache
Readonly children
container
Type declaration
Returns void
Optional cursor
display
Type declaration
Returns void
filter
filters
Optional hit
Optional interactive
Optional interactive
is
is
Readonly material
Readonly mesh
Optional name
parent
Optional render
renderable
sort
sortable
Optional tab
Optional tracked
Type declaration
[x: number]: InteractionTrackingData
transform
visible
world
Static prefixed
Accessors
Protected _temp
{PIXI.Container}
+- Preparing search index...
- The search index is not available
Pixi3D - v1.1.2Class InstancedMesh3D
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
mesh: Mesh3D
material: unknown
Returns InstancedMesh3D
Properties
Optional _accessible
Optional _accessible
_bounds
Protected _boundsID
Protected _bounds
Optional _cache
Optional _cache
Optional _cache
Protected _destroyed
Protected _enabled
Protected _height
_last
_local
Protected _local
_mask
Optional _tracked
Type declaration
[x: number]: InteractionTrackingData
Protected _width
Protected _z
Optional accessible
Optional accessible
Optional accessible
Optional accessible
Optional accessible
Optional accessible
alpha
Optional button
Optional cache
Optional cache
Readonly children
container
Type declaration
Returns void
Optional cursor
display
Type declaration
Returns void
filter
filters
Optional hit
Optional interactive
Optional interactive
is
is
Readonly material
Readonly mesh
Optional name
parent
Optional render
renderable
sort
sortable
Optional tab
Optional tracked
Type declaration
[x: number]: InteractionTrackingData
transform
visible
world
Static prefixed
Accessors
Protected _temp
{PIXI.Container}
Returns TemporaryDisplayObject
angle
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.
@@ -13,7 +13,7 @@Returns number
The height of the Container, setting this will actually modify the scale to achieve the value set
{number}
-Parameters
value: number
Returns void
local
Returns Matrix4
mask
Parameters
value: number
Returns void
local
Returns Matrix4
mask
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).
PixiJS 4
{PIXI.ObservablePoint}
-Parameters
value: ObservablePoint<any>
Returns void
position
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
rotation
Parameters
value: ObservablePoint<any>
Returns void
position
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
rotation
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.
{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.
{number}
-Parameters
value: number
Returns void
rotation
Parameters
value: number
Returns void
rotation
The quaternion rotation of the object.
-Returns ObservableQuaternion
Parameters
value: ObservableQuaternion
Returns void
scale
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
skew
Returns ObservableQuaternion
Parameters
value: ObservableQuaternion
Returns void
scale
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
skew
The skew factor for the object in radians.
PixiJS 4
{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
{number}
-Parameters
value: number
Returns void
world
Returns Matrix4
world
Parameters
value: number
Returns void
world
Returns Matrix4
world
Indicates if the object is globally visible.
{boolean}
Returns boolean
x
The position of the displayObject on the y axis relative to the local coordinates of the parent. An alias to position.y
{number}
-Parameters
value: number
Returns void
z
Parameters
value: number
Returns void
z
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
z
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
Returns void
destroy
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
disable
- Preparing search index...
- The search index is not available
Pixi3D - v1.1.1Class InstancedModel
- Preparing search index...
- The search index is not available
Pixi3D - v1.1.2Class InstancedModel
Represents an instance of a model.
-Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Creates a new model instance from the specified model.
Parameters
model: Model
The model to create instance from.
-Returns InstancedModel
Properties
Optional _accessible
Optional _accessible
_bounds
Protected _boundsID
Protected _bounds
Optional _cache
Optional _cache
Optional _cache
Protected _destroyed
Protected _enabled
Protected _height
_last
_local
Protected _local
_mask
Optional _tracked
Type declaration
[x: number]: InteractionTrackingData
Protected _width
Protected _z
Optional accessible
Optional accessible
Optional accessible
Optional accessible
Optional accessible
Optional accessible
alpha
Optional button
Optional cache
Optional cache
Readonly children
container
Type declaration
Returns void
Optional cursor
display
Type declaration
Returns void
filter
filters
Optional hit
Optional interactive
Optional interactive
is
is
meshes
Returns InstancedModel
Properties
Optional _accessible
Optional _accessible
_bounds
Protected _boundsID
Protected _bounds
Optional _cache
Optional _cache
Optional _cache
Protected _destroyed
Protected _enabled
Protected _height
_last
_local
Protected _local
_mask
Optional _tracked
Type declaration
[x: number]: InteractionTrackingData
Protected _width
Protected _z
Optional accessible
Optional accessible
Optional accessible
Optional accessible
Optional accessible
Optional accessible
alpha
Optional button
Optional cache
Optional cache
Readonly children
container
Type declaration
Returns void
Optional cursor
display
Type declaration
Returns void
filter
filters
Optional hit
Optional interactive
Optional interactive
is
is
meshes
The meshes included in the model.
-Optional name
parent
Optional render
renderable
sort
sortable
Optional tab
Optional tracked
Type declaration
[x: number]: InteractionTrackingData
transform
visible
world
Static prefixed
Accessors
Protected _temp
{PIXI.Container}
+Optional name
parent
Optional render
renderable
sort
sortable
Optional tab
Optional tracked
Type declaration
[x: number]: InteractionTrackingData
transform
visible
world
Static prefixed
Accessors
Protected _temp
{PIXI.Container}
Returns TemporaryDisplayObject
angle
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
{number}
-Parameters
value: number
Returns void
local
Returns Matrix4
mask
Parameters
value: number
Returns void
local
Returns Matrix4
mask
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).
PixiJS 4
{PIXI.ObservablePoint}
-Parameters
value: ObservablePoint<any>
Returns void
position
Returns ObservablePoint3D
Parameters
value: ObservablePoint3D
Returns void
rotation
Parameters
value: ObservablePoint<any>
Returns void
position