Class: PerspectiveCameraAuto

Cameras.PerspectiveCameraAuto

Extends the PerspectiveCamera to automatically adjust its aspect ratio on renderer resize.

Hierarchy

• PerspectiveCamera

  ↳ PerspectiveCameraAuto

Constructors

constructor

• new PerspectiveCameraAuto(fov?, near?, far?)

Parameters

Name	Type	Description
fov?	number	Camera frustum vertical field of view in degrees. Default 50.
near?	number	Camera frustum near plane distance. Default 0.1.
far?	number	Camera frustum far plane distance. Default 2000.

Overrides

PerspectiveCamera.constructor

Defined in

src/cameras/PerspectiveCameraAuto.ts:13

Properties

cursor

• cursor: Cursor

Cursor style when interacting with the object.

Inherited from

PerspectiveCamera.cursor

Defined in

src/patch/Object3D.ts:56

---

cursorDrag

• cursorDrag: Cursor

Cursor style when dragging the object.

Inherited from

PerspectiveCamera.cursorDrag

Defined in

src/patch/Object3D.ts:58

---

cursorDrop

• cursorDrop: Cursor

Cursor style when dropping an object onto this one.

Inherited from

PerspectiveCamera.cursorDrop

Defined in

src/patch/Object3D.ts:60

---

dragTarget

• dragTarget: Object3D<Object3DEventMap>

Indicates which object will be dragged instead of this one.

Inherited from

PerspectiveCamera.dragTarget

Defined in

src/patch/Object3D.ts:46

---

draggable

• draggable: boolean

Indicates whether the object is draggable. Default is DEFAULT_DRAGGABLE (false).

Inherited from

PerspectiveCamera.draggable

Defined in

src/patch/Object3D.ts:50

---

enabled

• enabled: boolean

Determines if the object is enabled. Default is true. If set to true, it allows triggering all InteractionEvents; otherwise, events are disabled.

Inherited from

PerspectiveCamera.enabled

Defined in

src/patch/Object3D.ts:40

---

findDropTarget

• findDropTarget: boolean

Determines when the object is dragged, whether it will have to search for any drop targets. Default is false.

Inherited from

PerspectiveCamera.findDropTarget

Defined in

src/patch/Object3D.ts:52

---

focusable

• focusable: boolean

Indicates whether the object can receive focus. Default is DEFAULT_FOCUSABLE (true).

Inherited from

PerspectiveCamera.focusable

Defined in

src/patch/Object3D.ts:48

---

hitboxes

• hitboxes: Hitbox[]

Array of hitboxes for collision detection.

Inherited from

PerspectiveCamera.hitboxes

Defined in

src/patch/Object3D.ts:44

---

interceptByRaycaster

• interceptByRaycaster: boolean

Determines if the object can be intercepted by the main raycaster. Default is DEFAULT_INTERCEPT_BY_RAYCASTER (true).

Inherited from

PerspectiveCamera.interceptByRaycaster

Defined in

src/patch/Object3D.ts:42

---

needsRender

• needsRender: boolean

Indicates whether the scene needs rendering.

Inherited from

PerspectiveCamera.needsRender

Defined in

src/patch/Object3D.ts:62

---

scene

• scene: Scene

Reference to the scene the object belongs to.

Inherited from

PerspectiveCamera.scene

Defined in

src/patch/Object3D.ts:54

---

tags

• tags: Set<string>

Indicates the tags to be searched using the querySelector and querySelectorAll methods.

Inherited from

PerspectiveCamera.tags

Defined in

src/patch/Object3D.ts:64

Accessors

clicking

• get clicking(): boolean

Indicates if the object is currently being clicked.

Returns

boolean

Inherited from

PerspectiveCamera.clicking

Defined in

src/patch/Object3D.ts:70

---

dragging

• get dragging(): boolean

Indicates if the object is currently being dragged.

Returns

boolean

Inherited from

PerspectiveCamera.dragging

Defined in

src/patch/Object3D.ts:72

---

enabledState

• get enabledState(): boolean

Retrieves the combined enabled state considering parent objects.

Returns

boolean

Inherited from

PerspectiveCamera.enabledState

Defined in

src/patch/Object3D.ts:74

---

firstFocusable

• get firstFocusable(): Object3D<Object3DEventMap>

Retrieves the first possible focusable object.

Returns

Object3D<Object3DEventMap>

Inherited from

PerspectiveCamera.firstFocusable

Defined in

src/patch/Object3D.ts:78

---

focused

• get focused(): boolean

Indicates if the object is currently focused.

Returns

boolean

Inherited from

PerspectiveCamera.focused

Defined in

src/patch/Object3D.ts:68

---

hovered

• get hovered(): boolean

Indicates if the primary pointer is over this object.

Returns

boolean

Inherited from

PerspectiveCamera.hovered

Defined in

src/patch/Object3D.ts:66

---

visibilityState

• get visibilityState(): boolean

Retrieves the combined visibility state considering parent objects.

Returns

boolean

Inherited from

PerspectiveCamera.visibilityState

Defined in

src/patch/Object3D.ts:76

Methods

applyBlur

▸ applyBlur(): void

Applies blur (removes focus) from the object.

Returns

void

Inherited from

PerspectiveCamera.applyBlur

Defined in

src/patch/Object3D.ts:86

---

applyFocus

▸ applyFocus(): void

Applies focus to the object.

Returns

void

Inherited from

PerspectiveCamera.applyFocus

Defined in

src/patch/Object3D.ts:82

---

bindProperty

▸ bindProperty<T>(property, getCallback, renderOnChange?): PerspectiveCameraAuto

Binds a property to a callback function for updates.

Type parameters

Name	Type
T	extends keyof PerspectiveCameraAuto

Parameters

Name	Type	Description
property	T	The name of the property to bind.
getCallback	() => PerspectiveCameraAuto[T]	A function that retrieves the property's value.
renderOnChange?	boolean	Indicates whether to render when the property changes (optional, default: false).

Returns

PerspectiveCameraAuto

The instance of the object with the binding applied.

Inherited from

PerspectiveCamera.bindProperty

Defined in

src/patch/Object3D.ts:138

---

detectChanges

▸ detectChanges(recursive?): void

Calculates all bindings on the current object. If 'recursive' is set to true, it will also calculate bindings for all children.

Parameters

Name	Type	Description
recursive?	boolean	If true, calculate bindings for children as well (optional, default: false).

Returns

void

Inherited from

PerspectiveCamera.detectChanges

Defined in

src/patch/Object3D.ts:130

---

hasEvent

▸ hasEvent<K>(type, listener): boolean

Checks if the object has a specific event listener.

Type parameters

Name	Type
K	extends keyof MiscEvents | keyof InteractionEvents<Object3D<Object3DEventMap>, Object3D<Object3DEventMap>, Object3D<Object3DEventMap> | InstancedMeshEntity> | keyof UpdateEvents

Parameters

Name	Type	Description
type	K	The type of event to check for.
listener	(event?: Events[K]) => void	The callback function to check.

Returns

boolean

true if the event listener is attached; otherwise, false.

Inherited from

PerspectiveCamera.hasEvent

Defined in

src/patch/Object3D.ts:100

---

off

▸ off<K>(type, listener): void

Removes an event listener from the object.

Type parameters

Name	Type
K	extends keyof MiscEvents | keyof InteractionEvents<Object3D<Object3DEventMap>, Object3D<Object3DEventMap>, Object3D<Object3DEventMap> | InstancedMeshEntity> | keyof UpdateEvents

Parameters

Name	Type	Description
type	K	The type of event to remove the listener from.
listener	(event?: Events[K]) => void	The callback function to remove.

Returns

void

Inherited from

PerspectiveCamera.off

Defined in

src/patch/Object3D.ts:106

---

on

▸ on<K>(type, listener): (event?: Events[K]) => void

Attaches an event listener to the object.

Type parameters

Name	Type
K	extends keyof MiscEvents | keyof InteractionEvents<Object3D<Object3DEventMap>, Object3D<Object3DEventMap>, Object3D<Object3DEventMap> | InstancedMeshEntity> | keyof UpdateEvents

Parameters

Name	Type	Description
type	K | K[]	The type of event to listen for.
listener	(this: PerspectiveCameraAuto, event?: Events[K]) => void	The callback function to execute when the event occurs.

Returns

fn

A function to remove the event listener.

▸ (event?): void

Attaches an event listener to the object.

Parameters

Name	Type
event?	Events[K]

Returns

void

A function to remove the event listener.

Inherited from

PerspectiveCamera.on

Defined in

src/patch/Object3D.ts:93

---

querySelector

▸ querySelector(query): Object3D<Object3DEventMap>

Finds and returns the first Object3D element that matches the specified query string. This method follows a similar syntax to CSS selectors.

Parameters

Name	Type	Description
query	string	The query string to match against the Object3D elements.

Returns

Object3D<Object3DEventMap>

The first Object3D element that matches the query, or undefined if no match is found.

Inherited from

PerspectiveCamera.querySelector

Defined in

src/patch/Object3D.ts:158

---

querySelectorAll

▸ querySelectorAll(query): Object3D<Object3DEventMap>[]

Finds and returns a list of Object3D elements that match the specified query string. This method follows a similar syntax to CSS selectors.

Parameters

Name	Type	Description
query	string	The query string to match against the Object3D elements.

Returns

Object3D<Object3DEventMap>[]

An array of Object3D elements that match the query.

Inherited from

PerspectiveCamera.querySelectorAll

Defined in

src/patch/Object3D.ts:165

---

setManualDetectionMode

▸ setManualDetectionMode(): void

Activates manual detection mode for bindings. When this method is used, all bindings will no longer be calculated automatically. Instead, they must be manually computed using the 'detectChanges' function.

Returns

void

Inherited from

PerspectiveCamera.setManualDetectionMode

Defined in

src/patch/Object3D.ts:124

---

trigger

▸ trigger<K>(type, event?): void

Triggers a specific event on the object.

Type parameters

Name	Type
K	extends keyof MiscEvents | keyof InteractionEvents<Object3D<Object3DEventMap>, Object3D<Object3DEventMap>, Object3D<Object3DEventMap> | InstancedMeshEntity> | keyof UpdateEvents

Parameters

Name	Type	Description
type	K	The type of event to trigger.
event?	Events[K]	Optional event data to pass to the listeners.

Returns

void

Inherited from

PerspectiveCamera.trigger

Defined in

src/patch/Object3D.ts:112

---

triggerAncestor

▸ triggerAncestor<K>(type, event?): void

Triggers a specific event on the object and all its ancestors.

Type parameters

Name	Type
K	extends keyof InteractionEvents<Object3D<Object3DEventMap>, Object3D<Object3DEventMap>, Object3D<Object3DEventMap> | InstancedMeshEntity>

Parameters

Name	Type	Description
type	K	The type of event to trigger.
event?	InteractionEvents<Object3D<Object3DEventMap>, Object3D<Object3DEventMap>, Object3D<Object3DEventMap> | InstancedMeshEntity>[K]	Optional event data to pass to the listeners.

Returns

void

Inherited from

PerspectiveCamera.triggerAncestor

Defined in

src/patch/Object3D.ts:118

---

tween

▸ tween<T>(id?): Tween<T>

Initiates a Tween animation for the object.

Type parameters

Name	Type	Description
T	extends Object3D<Object3DEventMap, T> = Object3D<Object3DEventMap>	The type of the target.

Parameters

Name	Type	Description
id?	string	Unique identifier. If you start a new tween, the old one with the same id (if specified) will be stopped.

Returns

Tween<T>

A Tween instance for further configuration.

Inherited from

PerspectiveCamera.tween

Defined in

src/patch/Object3D.ts:151

---

unbindProperty

▸ unbindProperty<T>(property): PerspectiveCameraAuto

Unbinds a previously bound property from the object.

Type parameters

Name	Type
T	extends keyof PerspectiveCameraAuto

Parameters

Name	Type	Description
property	T	The name of the property to unbind.

Returns

PerspectiveCameraAuto

The instance of the object with the binding removed.

Inherited from

PerspectiveCamera.unbindProperty

Defined in

src/patch/Object3D.ts:144