Class CinematicCameraSpaceComponent

Inheritance Relationships

Base Types

Class Documentation

class CinematicCameraSpaceComponent : public csp::multiplayer::ComponentBase, public csp::multiplayer::IThirdPartyComponentRef, public csp::multiplayer::IPositionComponent, public csp::multiplayer::IRotationComponent, public csp::multiplayer::IEnableableComponent

Data representation of an CinematicCameraSpaceComponent.

Public Functions

CinematicCameraSpaceComponent(SpaceEntity *Parent)

Constructs the CinematicCamera space component, and associates it with the specified Parent space entity.

Parameters

Parent – The Space entity that owns this component.

float GetFov() const

Gived the sensor size and focal length, return the horizonal fov.

Returns

FOV in radians

float GetFocalLength() const

Get focal length.

Returns

Current focal length

void SetFocalLength(float Value)

Set focalLength Note: Effects the result of GetFov()

Parameters

Value – float : focalLength

float GetAspectRatio() const

Get Current aspect ratio.

Returns

Current aspect ratio

void SetAspectRatio(float Value)

Set Current aspect ratio.

Parameters

Value – float : Current aspect ratio

const csp::common::Vector2 &GetSensorSize() const

Get sensor size.

Returns

Current sensor size

void SetSensorSize(const csp::common::Vector2 &Value)

Set Current SensorSize.

Parameters

Value – Vector2 : Current SensorSize

float GetNearClip() const

Get near clip Note: On platforms that don’t support reversedZ, near clip should be used to control the clipping distance.

Returns

Current near clip

void SetNearClip(float Value)

Set near clip.

Parameters

Value – float : near clip

float GetFarClip() const

Get far clip Note: On platforms that don’t support reversedZ, far clip should be used to control the clipping distance.

Returns

Current far clip

void SetFarClip(float Value)

Set far clip Note: far clip, controls how the density increases and height decreases.

Smaller values make the visible transition larger.

Parameters

Value – float : far clip

float GetIso() const

Get ISO sensitivity for controlling exposure.

Note: reserved for future use, do not implement on clients

Returns

Current iso

void SetIso(float Value)

Set ISO sensitivity for controlling exposure.

Note: reserved for future use, do not implement on clients

Parameters

Value – float : ISO sensitivity for controlling exposure.

float GetShutterSpeed() const

Get shutter speed.

Note: reserved for future use, do not implement on clients

Parameters

Value – float : shutter speed

void SetShutterSpeed(float Value)

Set shutter speed Note: reserved for future use, do not implement on clients.

Parameters

Value – float : shutter speed

float GetAperture() const

Get aperture.

Note: reserved for future use, do not implement on clients

Parameters

Value – float : aperture

void SetAperture(float Value)

Set aperture Note: reserved for future use, do not implement on clients.

Parameters

Value – float : aperture Flag

bool GetIsViewerCamera() const

Get IsViewerCamera.

Note: reserved for future use, do not implement on clients

Parameters

Value – boolean : IsViewerCamera

void SetIsViewerCamera(bool Value)

Set IsViewerCamera Note: reserved for future use, do not implement on clients.

Parameters

Value – boolean : IsViewerCamera Flag