NVIDIA IndeX API nvidia_logo_transpbg.gif Up

Generic scene descriptor class. More...

#include <xac_interface_scene_doc.h>

Public Member Functions

unsigned get_scene_id (const unsigned slot) const
 Slot retrieval function (id / global mapping) More...
 
const Mat4x4f & get_world_to_scene_transform () const
 Get function to retrieve transformation matrix. More...
 
const Mat4x4f & get_world_to_scene_transform_inverse () const
 Get function to retrieve inverse transformation matrix. More...
 
const Mat4x4f & get_world_to_camera_transform () const
 Get camera transformation matrix. More...
 
const Mat4x4f & get_world_to_camera_transform_inverse () const
 Get inverse camera transformation matrix. More...
 
const Mat4x4f & get_world_to_screen_transform () const
 Get screen transformation matrix. More...
 
const Mat4x4f & get_world_to_screen_transform_inverse () const
 Get inverse camera transformation matrix. More...
 
const Mat4x4f & get_scene_to_screen_transform () const
 Get transformation from scene coordinates into screen space. More...
 
const Mat4x4f & get_scene_to_screen_transform_inverse () const
 Get inverse transformation from scene coordinates into screen space. More...
 
template<typename ELEMENT_TYPE >
const ELEMENT_TYPE access_by_id (const uint scene_idx) const
 Retrieve a scene element by its subregion identifier for a given element type. More...
 
template<typename ELEMENT_TYPE >
const ELEMENT_TYPE access (const uint scene_idx) const
 Retrieve by its slot identifier for a given element type (returns a default object if slot id is invalid) More...
 
template<typename ELEMENT_TYPE >
bool is_valid_element (const uint scene_idx) const
 Check if a given slot id is valid for the given element type. More...
 
template<typename ELEMENT_TYPE >
uint get_number_of_elements () const
 Get the number of elements of a given element type in the scene. More...
 

Public Attributes

const Camera camera
 Camera representation. More...
 

Detailed Description

Generic scene descriptor class.

Member Function Documentation

 access()

template<typename ELEMENT_TYPE >
const ELEMENT_TYPE nv::index::xac::Scene::access ( const uint  scene_idx) const

Retrieve by its slot identifier for a given element type (returns a default object if slot id is invalid)

 access_by_id()

template<typename ELEMENT_TYPE >
const ELEMENT_TYPE nv::index::xac::Scene::access_by_id ( const uint  scene_idx) const

Retrieve a scene element by its subregion identifier for a given element type.

 get_number_of_elements()

template<typename ELEMENT_TYPE >
uint nv::index::xac::Scene::get_number_of_elements ( ) const

Get the number of elements of a given element type in the scene.

 get_scene_id()

unsigned nv::index::xac::Scene::get_scene_id ( const unsigned  slot) const

Slot retrieval function (id / global mapping)

 get_scene_to_screen_transform()

const Mat4x4f & nv::index::xac::Scene::get_scene_to_screen_transform ( ) const

Get transformation from scene coordinates into screen space.

 get_scene_to_screen_transform_inverse()

const Mat4x4f & nv::index::xac::Scene::get_scene_to_screen_transform_inverse ( ) const

Get inverse transformation from scene coordinates into screen space.

 get_world_to_camera_transform()

const Mat4x4f & nv::index::xac::Scene::get_world_to_camera_transform ( ) const

Get camera transformation matrix.

 get_world_to_camera_transform_inverse()

const Mat4x4f & nv::index::xac::Scene::get_world_to_camera_transform_inverse ( ) const

Get inverse camera transformation matrix.

 get_world_to_scene_transform()

const Mat4x4f & nv::index::xac::Scene::get_world_to_scene_transform ( ) const

Get function to retrieve transformation matrix.

 get_world_to_scene_transform_inverse()

const Mat4x4f & nv::index::xac::Scene::get_world_to_scene_transform_inverse ( ) const

Get function to retrieve inverse transformation matrix.

 get_world_to_screen_transform()

const Mat4x4f & nv::index::xac::Scene::get_world_to_screen_transform ( ) const

Get screen transformation matrix.

 get_world_to_screen_transform_inverse()

const Mat4x4f & nv::index::xac::Scene::get_world_to_screen_transform_inverse ( ) const

Get inverse camera transformation matrix.

 is_valid_element()

template<typename ELEMENT_TYPE >
bool nv::index::xac::Scene::is_valid_element ( const uint  scene_idx) const

Check if a given slot id is valid for the given element type.

Member Data Documentation

 camera

const Camera nv::index::xac::Scene::camera

Camera representation.


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