ScummVM API documentation
Stark::Resources::Camera Class Reference

#include <camera.h>

Inheritance diagram for Stark::Resources::Camera:
Stark::Resources::Object

Public Member Functions

 Camera (Object *parent, byte subType, uint16 index, const Common::String &name)
 
void onAllLoaded () override
 
void onEnterLocation () override
 
void setClipPlanes (float near, float far)
 
Math::Angle getHorizontalAngle () const
 
- Public Member Functions inherited from Stark::Resources::Object
Type getType () const
 
byte getSubType () const
 
uint16 getIndex () const
 
Common::String getIndexAsString () const
 
Common::String getName () const
 
virtual void saveLoad (ResourceSerializer *serializer)
 
virtual void saveLoadCurrent (ResourceSerializer *serializer)
 
virtual void onPostRead ()
 
virtual void onGameLoop ()
 
virtual void onEnginePause (bool pause)
 
virtual void onExitLocation ()
 
virtual void onPreDestroy ()
 
template<class T >
T * findParent ()
 
ObjectfindChildWithIndex (Type type, uint16 index, int subType=-1) const
 
ObjectfindChildWithOrder (Type type, uint16 order, int subType=-1) const
 
ObjectfindChildWithName (Type type, const Common::String &name, int subType=-1) const
 
template<class T >
T * findChild (bool mustBeUnique=true) const
 
template<class T >
T * findChildWithSubtype (int subType, bool mustBeUnique=true) const
 
template<class T >
T * findChildWithIndex (uint16 index, int subType=-1) const
 
template<class T >
T * findChildWithOrder (uint16 order, int subType=-1) const
 
template<class T >
T * findChildWithName (const Common::String &name, int subType=-1) const
 
template<class T >
Common::Array< T * > listChildren (int subType=-1) const
 
template<class T >
Common::Array< T * > listChildrenRecursive (int subType=-1)
 
void addChild (Object *child)
 
virtual void print (uint depth=0)
 
template<>
Objectcast (Object *resource)
 
template<>
ObjectfindParent ()
 
template<>
Common::Array< Object * > listChildren (int subType) const
 

Static Public Attributes

static const Type::ResourceType TYPE = Type::kCamera
 

Protected Member Functions

void readData (Formats::XRCReadStream *stream) override
 
void printData () override
 
- Protected Member Functions inherited from Stark::Resources::Object
 Object (Object *parent, byte subType, uint16 index, const Common::String &name)
 
void printWithDepth (uint depth, const Common::String &string) const
 
void printDescription (uint depth) const
 

Protected Attributes

Math::Vector3d _position
 
Math::Vector3d _lookDirection
 
float _f1
 
float _fov
 
Common::Rect _viewSize
 
Math::Vector3d _v4
 
float _nearClipPlane
 
float _farClipPlane
 
- Protected Attributes inherited from Stark::Resources::Object
Type _type
 
byte _subType
 
uint16 _index
 
Common::String _name
 
Object_parent
 
Common::Array< Object * > _children
 

Additional Inherited Members

- Static Public Member Functions inherited from Stark::Resources::Object
template<class T >
static T * cast (Object *resource)
 

Detailed Description

Camera resources define the camera position, perspective parameters, and look at direction.

Member Function Documentation

◆ onAllLoaded()

void Stark::Resources::Camera::onAllLoaded ( )
overridevirtual

Called when the resource sub-tree is entirely loaded.

Allows to load data from other nodes.

Reimplemented from Stark::Resources::Object.

◆ onEnterLocation()

void Stark::Resources::Camera::onEnterLocation ( )
overridevirtual

Called when entering a location

Reimplemented from Stark::Resources::Object.

◆ setClipPlanes()

void Stark::Resources::Camera::setClipPlanes ( float  near,
float  far 
)

Define the near and far clip planes distances

◆ getHorizontalAngle()

Math::Angle Stark::Resources::Camera::getHorizontalAngle ( ) const

Compute the angle between the X vector and the look at direction in the horizontal plane

◆ readData()

void Stark::Resources::Camera::readData ( Formats::XRCReadStream stream)
overrideprotectedvirtual

Deserialize the resource static data and initial state.

Reimplemented from Stark::Resources::Object.


The documentation for this class was generated from the following file: