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
@@ -66,13 +66,13 @@
Also be aware of that this may not work nicely with the addChildAt() function,
as the zIndex sorting may cause the child to automatically sorted to another position.
get mask(): null | Container<DisplayObject> | MaskData
set mask(value: null | Container<DisplayObject> | MaskData): void
Sets a mask for the displayObject. A mask is an object that limits the visibility of an
object to the shape of the mask applied to it. In PixiJS a regular mask must be a
{@link PIXI.Graphics} or a {@link PIXI.Sprite} object. This allows for much faster masking in canvas as it
@@ -131,26 +131,26 @@
const sprite = new PIXI.Sprite(texture);
sprite.mask = graphics;
todo
At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.
-
Parameters
value: null | Container<DisplayObject> | MaskData
Returns void
near
get near(): number
set near(value: number): void
+
Parameters
value: null | Container<DisplayObject> | 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.
Parameters
value: number
Returns void
pivot
get pivot(): ObservablePoint<any>
set pivot(value: IPointData): void
@@ -163,7 +163,7 @@
is the projection of pivot in the parent's local space.
The position of the displayObject on the x axis relative to the local coordinates of the parent.
@@ -201,10 +201,10 @@
Returns number
The position of the displayObject on the y axis relative to the local coordinates of the parent.
An alias to position.y
-
Parameters
value: number
Returns void
z
get z(): number
set z(value: number): void
+
Parameters
value: number
Returns void
z
get z(): number
set z(value: number): void
The position of the object on the z axis relative to the local
coordinates of the parent.
-
Returns number
+
Returns number
The position of the object on the z axis relative to the local
coordinates of the parent.
Parameters
value: number
Returns void
zIndex
get zIndex(): number
set zIndex(value: number): void
@@ -251,7 +251,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.
The bounds object, this is used to calculate and store the bounds of the displayObject.
@@ -61,7 +61,7 @@
Also be aware of that this may not work nicely with the addChildAt() function,
as the zIndex sorting may cause the child to automatically sorted to another position.
get mask(): null | Container<DisplayObject> | MaskData
set mask(value: null | Container<DisplayObject> | MaskData): void
Sets a mask for the displayObject. A mask is an object that limits the visibility of an
object to the shape of the mask applied to it. In PixiJS a regular mask must be a
{@link PIXI.Graphics} or a {@link PIXI.Sprite} object. This allows for much faster masking in canvas as it
@@ -120,15 +120,15 @@
is the projection of pivot in the parent's local space.
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.
The bounds object, this is used to calculate and store the bounds of the displayObject.
Protected _boundsID
_boundsID:number
Flags the cached bounds as dirty.
@@ -59,7 +59,7 @@
Also be aware of that this may not work nicely with the addChildAt() function,
as the zIndex sorting may cause the child to automatically sorted to another position.
get mask(): null | Container<DisplayObject> | MaskData
set mask(value: null | Container<DisplayObject> | MaskData): void
Sets a mask for the displayObject. A mask is an object that limits the visibility of an
object to the shape of the mask applied to it. In PixiJS a regular mask must be a
{@link PIXI.Graphics} or a {@link PIXI.Sprite} object. This allows for much faster masking in canvas as it
@@ -118,15 +118,15 @@
is the projection of pivot in the parent's local space.
The position of the displayObject on the x axis relative to the local coordinates of the parent.
@@ -150,10 +150,10 @@
Returns number
The position of the displayObject on the y axis relative to the local coordinates of the parent.
An alias to position.y
-
Parameters
value: number
Returns void
z
get z(): number
set z(value: number): void
+
Parameters
value: number
Returns void
z
get z(): number
set z(value: number): void
The position of the object on the z axis relative to the local
coordinates of the parent.
-
Returns number
+
Returns number
The position of the object on the z axis relative to the local
coordinates of the parent.
Parameters
value: number
Returns void
zIndex
get zIndex(): number
set zIndex(value: number): void
@@ -200,7 +200,7 @@
Recalculates the bounds of the container.
This implementation will automatically fit the children's bounds into the calculation. Each child's bounds
is limited to its mask's bounds or filterArea, if any is applied.
- Preparing search index...
- The search index is not available
Pixi3D - v2.3.1Class AABB
Axis-aligned bounding box.
-Hierarchy
Index
Constructors
Accessors
Methods
Constructors
constructor
Returns AABB
Accessors
center
Hierarchy
Index
Constructors
Accessors
Methods
Constructors
constructor
Returns AABB
Accessors
center
The center of the bounding box.
-Returns Point3D
extents
Returns Point3D
extents
The extents of the bounding box.
-Returns Point3D
max
Returns Point3D
max
The maximal point of the bounding box.
-Returns Point3D
Returns Point3D
The maximal point of the bounding box.
-Parameters
value: Point3D
Returns void
min
Parameters
value: Point3D
Returns void
min
The minimal point of the bounding box.
-Returns Point3D
Returns Point3D
The minimal point of the bounding box.
-Parameters
value: Point3D
Returns void
size
Parameters
value: Point3D
Returns void
size
The size of the bounding box.
-Returns Point3D
Methods
encapsulate
Returns Point3D
Methods
encapsulate
Grows the bounding box to include the point.
Parameters
point: { x: number; y: number; z: number }
The point to include.
-x: number
y: number
z: number
Returns void
Static from
x: number
y: number
z: number
Returns void
Static from
Creates a new bounding box from the specified source.
Parameters
source: { max: Float32Array; min: Float32Array }
The source to create the bounding box from.
diff --git a/docs/classes/Animation.html b/docs/classes/Animation.html index e1ac83a..8c8f53b 100644 --- a/docs/classes/Animation.html +++ b/docs/classes/Animation.html @@ -1,16 +1,16 @@ -- Preparing search index...
- The search index is not available
Pixi3D - v2.3.0Class Animation
- Preparing search index...
- The search index is not available
Pixi3D - v2.3.1Class 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 = 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 1db3409..bad4a5b 100644 --- a/docs/classes/Camera.html +++ b/docs/classes/Camera.html @@ -1,6 +1,6 @@ -- Preparing search index...
- The search index is not available
Pixi3D - v2.3.0Class Camera
- Preparing search index...
- The search index is not available
Pixi3D - v2.3.1Class 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
Also be aware of that this may not work nicely with the addChildAt() function, as the zIndex sorting may cause the child to automatically sorted to another position.
PIXI.settings.SORTABLE_CHILDREN
-tracked
Type declaration
[x: number]: InteractionTrackingData
transform
visible
tracked
Type declaration
[x: number]: InteractionTrackingData
transform
visible
The visibility of the object. If false the object will not be drawn, and the updateTransform function will not be called.
Only affects recursive calls from parent. You can ask for bounds or call updateTransform manually.
world
The multiplied alpha of the displayObject.
-Static main
Static main
Main camera which is used by default.
Static prefixed
Accessors
Protected _temp
{PIXI.Container}
Returns TemporaryDisplayObject
angle
Returns number
The angle of the object in degrees. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.
-Parameters
value: number
Returns void
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
destroyed
Readonly flag for destroyed display objects.
-Returns boolean
far
Returns boolean
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.
Returns number
The height of the Container, setting this will actually modify the scale to achieve the value set.
-Parameters
value: number
Returns void
local
Returns Matrix4x4
mask
Parameters
value: number
Returns void
local
Returns Matrix4x4
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 @@ -131,26 +131,26 @@
const sprite = new PIXI.Sprite(texture); sprite.mask = graphics;
At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.
-Parameters
value: null | Container<DisplayObject> | MaskData
Returns void
near
Parameters
value: null | Container<DisplayObject> | 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
pivotin the parent's local space.By default, the pivot is the origin (0, 0).
4.0.0
-Parameters
value: IPointData
Returns void
position
Returns Point3D
Parameters
value: Point3D
Returns void
projection
Parameters
value: IPointData
Returns void
position
Returns Point3D
Parameters
value: Point3D
Returns void
projection
Returns the projection matrix.
Returns Matrix4x4
rotation
The rotation of the object in radians. @@ -171,23 +171,23 @@
Returns number
The rotation of the object in radians. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.
-Parameters
value: number
Returns void
rotation
Parameters
value: number
Returns void
rotation
The quaternion rotation of the object.
-Returns Quaternion
Parameters
value: Quaternion
Returns void
scale
Returns Point3D
Parameters
value: Point3D
Returns void
skew
Returns Quaternion
Parameters
value: Quaternion
Returns void
scale
Returns Point3D
Parameters
value: Point3D
Returns void
skew
The skew factor for the object in radians.
4.0.0
Returns ObservablePoint<any>
The skew factor for the object in radians.
4.0.0
-Parameters
value: IPointData
Returns void
transform
Returns number
view
Parameters
value: IPointData
Returns void
transform
Returns number
view
Returns the view matrix.
-Returns Matrix4x4
view
Returns Matrix4x4
view
Returns the view projection matrix.
Returns Matrix4x4
width
The width of the Container, setting this will actually modify the scale to achieve the value set.
Returns number
The width of the Container, setting this will actually modify the scale to achieve the value set.
-Parameters
value: number
Returns void
world
Returns Matrix4x4
world
Parameters
value: number
Returns void
world
Returns Matrix4x4
world
Indicates if the object is globally visible.
Returns boolean
x
The position of the displayObject on the x axis relative to the local coordinates of the parent. @@ -201,10 +201,10 @@
Returns number
The position of the displayObject on the y axis relative to the local coordinates of the parent. An alias to position.y
-Parameters
value: number
Returns void
z
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
screen
Returns void
screen
Converts screen coordinates to a ray.
Parameters
x: number
Screen x coordinate.
@@ -392,7 +392,7 @@Screen y coordinate.
viewSize: { height: number; width: number } = ...
The size of the view when not rendering to the entire screen.
-height: number
width: number
Returns undefined | Ray
screen
height: number
width: number
Returns undefined | Ray
screen
Converts screen coordinates to world coordinates.
Parameters
x: number
Screen x coordinate.
@@ -476,7 +476,7 @@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 3bb6973..157520c 100644 --- a/docs/classes/CameraOrbitControl.html +++ b/docs/classes/CameraOrbitControl.html @@ -1,51 +1,51 @@ -- Preparing search index...
- The search index is not available
Pixi3D - v2.3.0Class CameraOrbitControl
- Preparing search index...
- The search index is not available
Pixi3D - v2.3.1Class 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
Protected _allow
Protected _angles
Protected _auto
Protected _camera
Protected _damping
Type declaration
x: number
y: number
Protected _damping
Protected _damping
Protected _distance
Protected _element
Protected _enable
Protected _grabbed
Protected _previous
Protected _previous
Protected _previous
Protected _target
Type declaration
x: number
y: number
z: number
Accessors
allow
Returns CameraOrbitControl
Properties
Protected _allow
Protected _angles
Protected _auto
Protected _camera
Protected _damping
Type declaration
x: number
y: number
Protected _damping
Protected _damping
Protected _distance
Protected _element
Protected _enable
Protected _grabbed
Protected _previous
Protected _previous
Protected _previous
Protected _target
Type declaration
x: number
y: number
z: number
Accessors
allow
Allows the camera to be controlled by user.
-Returns boolean
Returns boolean
Allows the camera to be controlled by user.
-Parameters
value: boolean
Returns void
angles
Parameters
value: boolean
Returns void
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>
auto
Returns ObservablePoint<undefined>
auto
Whether to auto update the camera on prerender. Default is true.
-Returns boolean
Returns boolean
Whether to auto update the camera on prerender. Default is true.
-Parameters
value: boolean
Returns void
camera
Parameters
value: boolean
Returns void
camera
The camera being controlled.
-Returns Camera
Returns Camera
The camera being controlled.
-Parameters
value: Camera
Returns void
damping
Parameters
value: Camera
Returns void
damping
The damping inertia used if enableDamping is true. Default is 0.1.
-Returns number
Returns number
The damping inertia used if enableDamping is true. Default is 0.1.
-Parameters
value: number
Returns void
distance
Parameters
value: number
Returns void
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
enable
Parameters
value: number
Returns void
enable
Value indicating if damping (inertia) is enabled, which can be used to give a sense of weight to the controls. Default is false.
-Returns boolean
Returns boolean
Value indicating if damping (inertia) is enabled, which can be used to give a sense of weight to the controls. Default is false.
-Parameters
value: boolean
Returns void
target
Parameters
value: boolean
Returns void
target
Target position (x, y, z) to orbit.
-Returns { x: number; y: number; z: number }
x: number
y: number
z: number
Returns { x: number; y: number; z: number }
x: number
y: number
z: number
Target position (x, y, z) to orbit.
-Parameters
value: { x: number; y: number; z: number }
x: number
y: number
z: number
Returns void
Methods
Protected bind
Returns void
destroy
Returns void
Protected on
Parameters
e: MouseEvent
Returns void
Protected on
Parameters
e: InteractionEvent
Returns void
Protected on
Parameters
e: MouseEvent
Returns void
Protected on
Parameters
_e: MouseEvent
Returns void
Protected on
Parameters
e: TouchEvent
Returns void
Protected on
Parameters
clientX: number
clientY: number
Returns void
Protected on
Parameters
clientX: number
clientY: number
Returns void
Protected on
Returns void
Protected on
Returns void
Protected on
Parameters
e: TouchEvent
Returns void
Protected on
Parameters
e: TouchEvent
Returns void
Protected on
Parameters
e: TouchEvent
Returns void
Protected on
Parameters
e: WheelEvent
Returns void
Protected unbind
Returns void
update
Parameters
value: { x: number; y: number; z: number }
x: number
y: number
z: number
Returns void
Methods
Protected bind
Returns void
destroy
Returns void
Protected on
Parameters
e: MouseEvent
Returns void
Protected on
Parameters
e: InteractionEvent
Returns void
Protected on
Parameters
e: MouseEvent
Returns void
Protected on
Parameters
_e: MouseEvent
Returns void
Protected on
Parameters
e: TouchEvent
Returns void
Protected on
Parameters
clientX: number
clientY: number
Returns void
Protected on
Parameters
clientX: number
clientY: number
Returns void
Protected on
Returns void
Protected on
Returns void
Protected on
Parameters
e: TouchEvent
Returns void
Protected on
Parameters
e: TouchEvent
Returns void
Protected on
Parameters
e: TouchEvent
Returns void
Protected on
Parameters
e: WheelEvent
Returns void
Protected unbind
Returns void
update
Updates the position and rotation of the camera.
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
Pixi3D - v2.3.0Class Color
- Preparing search index...
- The search index is not available
Pixi3D - v2.3.1Class 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/CompositeSprite.html b/docs/classes/CompositeSprite.html index dff58c6..6759c31 100644 --- a/docs/classes/CompositeSprite.html +++ b/docs/classes/CompositeSprite.html @@ -1,7 +1,7 @@ -- Preparing search index...
- The search index is not available
Pixi3D - v2.3.0Class CompositeSprite
- Preparing search index...
- The search index is not available
Pixi3D - v2.3.1Class CompositeSprite
Represents a sprite used for compositing a 3D object as a 2D sprite. Can be used for post processing effects and filters.
-Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Creates a new composite sprite using the specified options.
Parameters
renderer: Renderer
The renderer to use.
@@ -190,7 +190,7 @@Returns ObservablePoint<any>
The coordinate of the object relative to the local coordinates of the parent.
4.0.0
-Parameters
value: IPointData
Returns void
render
Parameters
value: IPointData
Returns void
render
The render texture.
Returns RenderTexture
rotation
The rotation of the object in radians. @@ -311,7 +311,7 @@
Parameters
point: IPointData
the point to test
Returns boolean
The result of the test
-destroy
Parameters
Optional options: boolean | IDestroyOptions
Returns void
disable
destroy
Parameters
Optional options: boolean | IDestroyOptions
Returns void
disable
Pair method for
enableTempParentParameters
cacheParent: Container<DisplayObject>
Actual parent of element
@@ -434,7 +434,7 @@Render the object using the WebGL renderer and advanced features.
Parameters
renderer: Renderer
The renderer
-Returns void
render
Returns void
render
Updates the sprite's texture by rendering the specified object to it.
Parameters
object: DisplayObject
The object to render.
@@ -451,7 +451,7 @@Returns Container<DisplayObject>
- The Container that this DisplayObject was added to.
-set
set
Sets the resolution of the render texture.
Parameters
resolution: number
The resolution to set.
diff --git a/docs/classes/Container3D.html b/docs/classes/Container3D.html index 24d2e7b..74e620b 100644 --- a/docs/classes/Container3D.html +++ b/docs/classes/Container3D.html @@ -1,4 +1,4 @@ -- Preparing search index...
- The search index is not available
Pixi3D - v2.3.0Class Container3D
- Preparing search index...
- The search index is not available
Pixi3D - v2.3.1Class Container3D
A container represents a collection of 3D objects.
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Returns Container3D
Properties
_bounds
The bounds object, this is used to calculate and store the bounds of the displayObject.
@@ -61,7 +61,7 @@Also be aware of that this may not work nicely with the addChildAt() function, as the zIndex sorting may cause the child to automatically sorted to another position.
PIXI.settings.SORTABLE_CHILDREN
-tracked
Type declaration
[x: number]: InteractionTrackingData
transform
visible
tracked
Type declaration
[x: number]: InteractionTrackingData
transform
visible
The visibility of the object. If false the object will not be drawn, and the updateTransform function will not be called.
Only affects recursive calls from parent. You can ask for bounds or call updateTransform manually.
@@ -80,7 +80,7 @@The height of the Container, setting this will actually modify the scale to achieve the value set.
Returns number
The height of the Container, setting this will actually modify the scale to achieve the value set.
-Parameters
value: number
Returns void
local
Returns Matrix4x4
mask
Parameters
value: number
Returns void
local
Returns Matrix4x4
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 @@ -120,15 +120,15 @@ is the projection of
pivotin the parent's local space.By default, the pivot is the origin (0, 0).
4.0.0
-Parameters
value: IPointData
Returns void
position
Returns Point3D
Parameters
value: Point3D
Returns void
rotation
Parameters
value: IPointData
Returns void
position
Returns Point3D
Parameters
value: Point3D
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.
Returns number
The rotation of the object in radians. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.
-Parameters
value: number
Returns void
rotation
Parameters
value: number
Returns void
rotation
The quaternion rotation of the object.
-Returns Quaternion
Parameters
value: Quaternion
Returns void
scale
Returns Point3D
Parameters
value: Point3D
Returns void
skew
Returns Quaternion
Parameters
value: Quaternion
Returns void
scale
Returns Point3D
Parameters
value: Point3D
Returns void
skew
The skew factor for the object in radians.
4.0.0
Returns ObservablePoint<any>
The width of the Container, setting this will actually modify the scale to achieve the value set.
Returns number
The width of the Container, setting this will actually modify the scale to achieve the value set.
-Parameters
value: number
Returns void
world
Returns Matrix4x4
world
Parameters
value: number
Returns void
world
Returns Matrix4x4
world
Indicates if the object is globally visible.
Returns boolean
x
The position of the displayObject on the x axis relative to the local coordinates of the parent. @@ -152,10 +152,10 @@
Returns number
The position of the displayObject on the y axis relative to the local coordinates of the parent. An alias to position.y
-Parameters
value: number
Returns void
z
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 - v2.3.0Class Cubemap
- Preparing search index...
- The search index is not available
Pixi3D - v2.3.1Class Cubemap
Cubemap which supports multiple user specified mipmaps.
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
Optional resource: any
Optional options: IBaseTextureOptions<IAutoDetectOptions>
Collection of options
@@ -19,7 +19,7 @@cache
Currently default cache ID.
{string}
-cubemap
cubemap
The format for this cubemap.
destroyed
Flag if BaseTexture has been destroyed.
@@ -70,7 +70,7 @@The width of the base texture set when the image has loaded
Static _global
Global number of the texture batch, used by multi-texture renderers.
-Static prefixed
Accessors
levels
Static prefixed
Accessors
levels
Returns the number of mipmap levels.
Returns number
mipmap
Mipmap mode of the texture, affects downscaled images
@@ -94,7 +94,7 @@Returns WRAP_MODES
How the texture wraps
PIXI.settings.WRAP_MODE
-Parameters
value: WRAP_MODES
Returns void
Static faces
Parameters
value: WRAP_MODES
Returns void
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.
@@ -204,7 +204,7 @@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.
@@ -218,7 +218,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 f9d1834..7c7e3d6 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 - v2.3.0Class CubemapResource
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
source: MipmapResourceArray
levels: number = 1
Returns CubemapResource
Properties
Protected _height
- Preparing search index...
- The search index is not available
Pixi3D - v2.3.1Class CubemapResource
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
source: MipmapResourceArray
levels: number = 1
Returns CubemapResource
Properties
Protected _height
Internal height of the resource.
Protected _width
Internal width of the resource.
@@ -63,7 +63,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.
Parameters
baseTexture: BaseTexture<Resource, IAutoDetectOptions>
Returns void
update
- Preparing search index...
- The search index is not available
Pixi3D - v2.3.0Class ImageBasedLighting
- Preparing search index...
- The search index is not available
Pixi3D - v2.3.1Class 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 - v2.3.0Class InstancedMesh3D
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
mesh: Mesh3D
material: unknown
Returns InstancedMesh3D
Properties
_bounds
- Preparing search index...
- The search index is not available
Pixi3D - v2.3.1Class InstancedMesh3D
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
mesh: Mesh3D
material: unknown
Returns InstancedMesh3D
Properties
_bounds
The bounds object, this is used to calculate and store the bounds of the displayObject.
Protected _boundsID
Flags the cached bounds as dirty.
@@ -59,7 +59,7 @@Also be aware of that this may not work nicely with the addChildAt() function, as the zIndex sorting may cause the child to automatically sorted to another position.
PIXI.settings.SORTABLE_CHILDREN
-tracked
Type declaration
[x: number]: InteractionTrackingData
transform
visible
tracked
Type declaration
[x: number]: InteractionTrackingData
transform
visible
The visibility of the object. If false the object will not be drawn, and the updateTransform function will not be called.
Only affects recursive calls from parent. You can ask for bounds or call updateTransform manually.
@@ -78,7 +78,7 @@The height of the Container, setting this will actually modify the scale to achieve the value set.
Returns number
The height of the Container, setting this will actually modify the scale to achieve the value set.
-Parameters
value: number
Returns void
local
Returns Matrix4x4
mask
Parameters
value: number
Returns void
local
Returns Matrix4x4
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 @@ -118,15 +118,15 @@ is the projection of
pivotin the parent's local space.By default, the pivot is the origin (0, 0).
4.0.0
-Parameters
value: IPointData
Returns void
position
Returns Point3D
Parameters
value: Point3D
Returns void
rotation
Parameters
value: IPointData
Returns void
position
Returns Point3D
Parameters
value: Point3D
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.
Returns number
The rotation of the object in radians. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.
-Parameters
value: number
Returns void
rotation
Parameters
value: number
Returns void
rotation
The quaternion rotation of the object.
-Returns Quaternion
Parameters
value: Quaternion
Returns void
scale
Returns Point3D
Parameters
value: Point3D
Returns void
skew
Returns Quaternion
Parameters
value: Quaternion
Returns void
scale
Returns Point3D
Parameters
value: Point3D
Returns void
skew
The skew factor for the object in radians.
4.0.0
Returns ObservablePoint<any>
The width of the Container, setting this will actually modify the scale to achieve the value set.
Returns number
The width of the Container, setting this will actually modify the scale to achieve the value set.
-Parameters
value: number
Returns void
world
Returns Matrix4x4
world
Parameters
value: number
Returns void
world
Returns Matrix4x4
world
Indicates if the object is globally visible.
Returns boolean
x
The position of the displayObject on the x axis relative to the local coordinates of the parent. @@ -150,10 +150,10 @@
Returns number
The position of the displayObject on the y axis relative to the local coordinates of the parent. An alias to position.y
-Parameters
value: number
Returns void
z
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 - v2.3.0Class InstancedModel