About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Class Camera

Class representing the camera in a 3D scatter plot.

Since

2.0

Hierarchy (view full)

DocumentNode
- Camera

Implements

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Context Direction FieldOfView IsAttached Position Transactions UpDirection Reset

Methods

Cast

Cast<T1, T2>(this, type): T1
Casts this object to the specified type. Throws error on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from DocumentNode.Cast

Equals

Equals(obj): boolean
Determines whether the specified object is equal to the current object.
Parameters
- obj: any
  The object to compare with the current object.
Returns boolean
true if the specified object is equal to the current object; otherwise, false.

Inherited from DocumentNode.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from DocumentNode.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from DocumentNode.ToString

TryCast

TryCast<T1, T2>(this, type): null | T1
Casts this object to the specified type. Returns null on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from DocumentNode.TryCast

`Static`Equals

Equals(objA, objB): boolean
Determines whether the specified object instances are considered equal.
Parameters
- objA: any
  The first object to compare.
- objB: any
  The second object to compare.
Returns boolean
true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Inherited from DocumentNode.Equals

Default capability

Context

get Context(): INodeContext
Gets the context of this node.

Returns INodeContext
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Context

Direction

get Direction(): Tuple3D
Gets or sets the direction in which the camera is looking.

Returns Tuple3D
Since
2.0
set Direction(value): void
Parameters
- value: Tuple3D
Returns void

FieldOfView

get FieldOfView(): number
Gets the field of view in, in degrees.

Returns number
Since
2.0

IsAttached

get IsAttached(): boolean
Gets a value indicating whether this node is attached.

Returns boolean
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.IsAttached

Position

get Position(): Tuple3D
Gets of sets the position of the camera.

Returns Tuple3D
Since
2.0
set Position(value): void
Parameters
- value: Tuple3D
Returns void

Transactions

get Transactions(): ITransactions
Gets a collection of methods for executing transactions on the document.

Returns ITransactions
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Transactions

UpDirection

get UpDirection(): Tuple3D
Sets or gets the up direction.

Returns Tuple3D
Since
2.0
set UpDirection(value): void
Parameters
- value: Tuple3D
Returns void

Reset

Reset(): void
Resets camera to its default position and direction.

Returns void
Since
2.0