#include <Camera.h>
Inheritance diagram for vsg::Camera:
Collaboration diagram for vsg::Camera:
Public Member Functions | |
| Camera (ref_ptr< ProjectionMatrix > in_projectionMatrix, ref_ptr< ViewMatrix > in_viewMatrix, ref_ptr< ViewportState > in_viewportState={}) | |
| VkViewport | getViewport () const |
| VkRect2D | getRenderArea () const |
| void | read (Input &input) override |
| void | write (Output &output) const override |
 Public Member Functions inherited from vsg::Inherit< Node, Camera > | |
| Inherit (Args &&... args) | |
| std::size_t | sizeofObject () const noexcept override |
| const char * | className () const noexcept override |
| const std::type_info & | type_info () const noexcept override |
| bool | is_compatible (const std::type_info &type) const noexcept override |
| int | compare (const Object &rhs) const override |
| void | accept (Visitor &visitor) override |
| void | accept (ConstVisitor &visitor) const override |
| void | accept (RecordTraversal &visitor) const override |
| Public Member Functions inherited from vsg::Inherit< Object, Node > | |
| Inherit (Args &&... args) | |
| Public Member Functions inherited from vsg::Object | |
| Object (const Object &) | |
| Object & | operator= (const Object &) |
| template<class T > | |
| T * | cast () |
| template<class T > | |
| const T * | cast () const |
| virtual void | traverse (Visitor &) |
| virtual void | traverse (ConstVisitor &) const |
| virtual void | traverse (RecordTraversal &) const |
| void | ref () const noexcept |
| void | unref () const noexcept |
| void | unref_nodelete () const noexcept |
| unsigned int | referenceCount () const noexcept |
| template<typename T > | |
| void | setValue (const std::string &key, const T &value) |
| void | setValue (const std::string &key, const char *value) |
| specialization of setValue to handle passing C strings | |
| template<typename T > | |
| bool | getValue (const std::string &key, T &value) const |
| get specified value type, return false if value associated with key is not assigned or is not the correct type | |
| void | setObject (const std::string &key, ref_ptr< Object > object) |
| assign an Object associated with key | |
| Object * | getObject (const std::string &key) |
| get Object pointer associated with key, return nullptr if no object associated with key has been assigned | |
| const Object * | getObject (const std::string &key) const |
| get const Object pointer associated with key, return nullptr if no object associated with key has been assigned | |
| template<class T > | |
| T * | getObject (const std::string &key) |
| get object pointer of specified type associated with key, return nullptr if no object associated with key has been assigned | |
| template<class T > | |
| const T * | getObject (const std::string &key) const |
| get const object pointer of specified type associated with key, return nullptr if no object associated with key has been assigned | |
| ref_ptr< Object > | getRefObject (const std::string &key) |
| get ref_ptr<Object> associated with key, return nullptr if no object associated with key has been assigned | |
| ref_ptr< const Object > | getRefObject (const std::string &key) const |
| get ref_ptr<const Object> pointer associated with key, return nullptr if no object associated with key has been assigned | |
| template<class T > | |
| ref_ptr< T > | getRefObject (const std::string &key) |
| get ref_ptr<T> of specified type associated with key, return nullptr if no object associated with key has been assigned | |
| template<class T > | |
| const ref_ptr< const T > | getRefObject (const std::string &key) const |
| get ref_ptr<const T> of specified type associated with key, return nullptr if no object associated with key has been assigned | |
| void | removeObject (const std::string &key) |
| remove meta object or value associated with key | |
| Auxiliary * | getOrCreateAuxiliary () |
| Auxiliary * | getAuxiliary () |
| const Auxiliary * | getAuxiliary () const |
Public Attributes | |
| std::string | name |
| ref_ptr< ProjectionMatrix > | projectionMatrix |
| ref_ptr< ViewMatrix > | viewMatrix |
| ref_ptr< ViewportState > | viewportState |
Additional Inherited Members | |
| Static Public Member Functions inherited from vsg::Inherit< Node, Camera > | |
| static ref_ptr< Camera > | create (Args &&... args) |
| static ref_ptr< Camera > | create_if (bool flag, Args &&... args) |
| Static Public Member Functions inherited from vsg::Node | |
| static void * | operator new (std::size_t count) |
| provide new and delete to enable custom memory management via the vsg::Allocator singleton, using the MEMORY_NODES_OBJECTS | |
| static void | operator delete (void *ptr) |
| Static Public Member Functions inherited from vsg::Inherit< Object, Node > | |
| static ref_ptr< Node > | create (Args &&... args) |
| static ref_ptr< Node > | create_if (bool flag, Args &&... args) |
| Static Public Member Functions inherited from vsg::Object | |
| static ref_ptr< Object > | create () |
| static ref_ptr< Object > | create_if (bool flag) |
| static void * | operator new (std::size_t count) |
| provide new and delete to enable custom memory management via the vsg::Allocator singleton, using the MEMORY_AFFINTY_OBJECTS | |
| static void | operator delete (void *ptr) |
| Protected Member Functions inherited from vsg::Object | |
| virtual void | _attemptDelete () const |
| void | setAuxiliary (Auxiliary *auxiliary) |
Detailed Description
Camera class provides the projection and view matrices, and viewport settings that control what a View looks at in a scene. Typically assigned to a vsg::View, but can also be placed in the scene graph for cases where applications want to track an in scene camera or to specify defined views within the scene, such as places of interest.
The documentation for this class was generated from the following file:
- include/vsg/app/Camera.h
