HOOPS Communicator Documentation

Object representing a viewpoint from which the scene can be rendered. More information about using Camera can be found here.

Methods

copy

copy(): Camera

Creates a copy of the camera.

Returns Camera

new object initialized with the current values of this camera

dolly

dolly(delta: Point3): void

Move the camera along a delta

Parameters
- delta: Point3
Returns void

equals

equals(cam: Camera): boolean

Returns checks for equality with another camera

Parameters
- cam: Camera
  
  the camera to compare against
Returns boolean

forJson [deprecated]

forJson(): Object

deprecated

Use toJson instead.

Returns Object

getCameraPlaneIntersectionPoint

getCameraPlaneIntersectionPoint(point: Point2, view: View): Point3 | null

Finds the intersection point with the camera plane

Parameters
- point: Point2
- view: View
Returns Point3 | null

getFullMatrix

getFullMatrix(viewer: WebViewer): Matrix

Returns the camera's projection matrix multiplied by its view matrix.

Parameters
- viewer: WebViewer
  
  The WebViewer for which the matrix should be valid.
Returns Matrix

getHeight

getHeight(): number

gets the camera height

Returns number

the camera width

getMatrixFromCamera [deprecated]

getMatrixFromCamera(): Matrix

Returns the transpose of the camera's view matrix without the translation component and with the x- and z- axes flipped. See getViewMatrix.

deprecated

Returns Matrix

getNearLimit

getNearLimit(): number

gets the camera near clipping limit

Returns number

the camera near clipping limit

getPosition

getPosition(): Point3

gets the camera position

Returns Point3

the camera position

getProjection

getProjection(): Projection

gets the camera projection

Returns Projection

the camera projection

getProjectionMatrix

getProjectionMatrix(viewer: WebViewer): Matrix

Returns the camera's projection matrix.

Parameters
- viewer: WebViewer
  
  The WebViewer for which the matrix should be valid.
Returns Matrix

getTarget

getTarget(): Point3

gets the camera target

Returns Point3

the camera target

getUp

getUp(): Point3

gets the camera up vector

Returns Point3

the camera up vector

getViewMatrix

getViewMatrix(viewer: WebViewer): Matrix

Returns the camera's view matrix. This matrix places the camera at <0,0,0>, with the negative z-axis pointing toward the camera's target and the y-axis in the direction of the camera's up-vector.

Parameters
- viewer: WebViewer
  
  The WebViewer for which the matrix should be valid.
Returns Matrix

getWidth

getWidth(): number

gets the camera width

Returns number

the camera width

setHeight

setHeight(height: number): void

Sets the camera height

Parameters
- height: number
  
  the new camera height
Returns void

setNearLimit

setNearLimit(nearLimit: number): void

Sets the camera near clipping limit

Parameters
- nearLimit: number
  
  the new camera near clipping limit
Returns void

setPosition

setPosition(position: Point3): void

Sets the camera position

Parameters
- position: Point3
  
  the new camera position
Returns void

setProjection

setProjection(projection: Projection): void

Sets the camera projection

Parameters
- projection: Projection
  
  the new camera Projection
Returns void

setTarget

setTarget(target: Point3): void

Sets the camera target

Parameters
- target: Point3
  
  the new camera target
Returns void

setUp

setUp(up: Point3): void

Sets the camera up vector

Parameters
- up: Point3
  
  the new camera up vector
Returns void

setWidth

setWidth(width: number): void

Sets the camera width

Parameters
- width: number
  
  the new camera width
Returns void

toJson

toJson(): Object

Creates an object ready for JSON serialization.

Returns Object

The prepared object.

transform

transform(matrix: Matrix): Camera

Parameters
- matrix: Matrix
Returns Camera

Static construct [deprecated]

construct(obj: any): Camera

deprecated

Use fromJson instead.

Parameters
- obj: any
Returns Camera

Static create

create(pos: Point3, tar: Point3, up: Point3, projection: Projection, width: number, height: number, nearLimit?: number): Camera

Creates a new camera object with the given parameters.

Parameters
- pos: Point3
  
  the camera position.
- tar: Point3
  
  the camera target.
- up: Point3
  
  the camera up vector.
- projection: Projection
  
  the camera projection mode.
- width: number
  
  camea view width.
- height: number
  
  camera view height.
- Optional nearLimit: number
  
  the camera near limit.
Returns Camera

a new camera object.

Static fromJson

fromJson(objData: any): Camera

Creates a new Camera from an object given by toJson.

Parameters
- objData: any
  
  An object given by toJson.
Returns Camera

The prepared object.