nv::index::Sparse_volume Class Reference

Sparse volume reference class. More...

#include <xac_interface_scene_elements_sparse_volume_doc.h>

Public Types
typedef Sample_info_sparse_volume	Base_info_type
	Declaring the sparse volume sample info. More...

Public Member Functions
template<typename SVOL_attrib_type , Volume_filter_mode SVOL_filter_mode = default_filter_mode, Volume_classification_mode SVOL_classify_mode = default_classification_mode>
Sparse_volume_sampler<SVOL_attrib_type, SVOL_filter_mode, SVOL_classify_mode>	generate_sampler (const unsigned attrib_idx, const Sparse_volume_sample_context &sample_context) const
	Generates a sparse volume sampler object of a given sample context for local sampling operations. More...
template<typename SVOL_attrib_type , Volume_filter_mode SVOL_filter_mode = default_filter_mode, Volume_classification_mode SVOL_classify_mode = default_classification_mode>
Sparse_volume_sampler<SVOL_attrib_type, SVOL_filter_mode, SVOL_classify_mode>	generate_sampler (const unsigned attrib_idx) const
	Generates a sparse volume sampler object without providing an existing sample context. More...
xac::Colormap	get_colormap () const
	Get the colormap currently associated with the volume through the scene setup. More...
float	get_sample_distance () const const float3 &get_volume_bbox_min() const
	Get distance of the current sample position to the camera. More...
const float3 &	get_volume_bbox_max () const
	Get the sparse volume bounding box maximum coordinate. More...
const Mat4x4f &	get_scene_to_object_transform () const
	Get the transformation matrix to transform from scene space to object space coordinates. More...
const Mat4x4f &	get_scene_to_object_transform_inverse () const
	Get the transformation matrix to transform from object space to scene space coordinates. More...
template<typename SVOL_attrib_type>
SVOL_attrib_type	get_attribute (const unsigned attrib_idx, const Data_point_info_sparse_volume &data_point_info) const
	Function to retrieve information on the current voxel during XAC compute operations. More...

Detailed Description

Sparse volume reference class.

Member Typedef Documentation

Base_info_type

typedef Sample_info_sparse_volume nv::index::Sparse_volume::Base_info_type

Declaring the sparse volume sample info.

Member Function Documentation

generate_sampler() [1/2]

template<typename SVOL_attrib_type , Volume_filter_mode SVOL_filter_mode = default_filter_mode, Volume_classification_mode SVOL_classify_mode = default_classification_mode>

Sparse_volume_sampler<SVOL_attrib_type, SVOL_filter_mode, SVOL_classify_mode> nv::index::Sparse_volume::generate_sampler

(

const unsigned

attrib_idx

)

const

Generates a sparse volume sampler object without providing an existing sample context.

The required sample context is created lazily upon the first sample operation.

Note

: The default filter and classification modes are derived from the filter mode set for the sparse volume scene element through the scene specification. For kernel programs defined for other scene elements the default modes are set the nearest neighbor filtering using post-classification.

generate_sampler() [2/2]

template<typename SVOL_attrib_type , Volume_filter_mode SVOL_filter_mode = default_filter_mode, Volume_classification_mode SVOL_classify_mode = default_classification_mode>

Sparse_volume_sampler<SVOL_attrib_type, SVOL_filter_mode, SVOL_classify_mode> nv::index::Sparse_volume::generate_sampler	(	const unsigned	attrib_idx,
		const Sparse_volume_sample_context &	sample_context
	)		const

Generates a sparse volume sampler object of a given sample context for local sampling operations.

Note

: The default filter and classification modes are derived from the filter mode set for the sparse volume scene element through the scene specification. For kernel programs defined for other scene elements the default modes are set the nearest neighbor filtering using post-classification.

get_attribute()

template<typename SVOL_attrib_type>

SVOL_attrib_type nv::index::Sparse_volume::get_attribute ( const unsigned  attrib_idx, const Data_point_info_sparse_volume &  data_point_info  ) const

inline

Function to retrieve information on the current voxel during XAC compute operations.

get_colormap()

xac::Colormap nv::index::Sparse_volume::get_colormap

(

)

const

Get the colormap currently associated with the volume through the scene setup.

Note

: The colormap is only valid for the sparse volume self reference.

get_sample_distance()

float nv::index::Sparse_volume::get_sample_distance

(

)

const &

Get distance of the current sample position to the camera.

Get the sparse volume bounding box minimum coordinate

get_scene_to_object_transform()

const Mat4x4f & nv::index::Sparse_volume::get_scene_to_object_transform

(

)

const

Get the transformation matrix to transform from scene space to object space coordinates.

get_scene_to_object_transform_inverse()

const Mat4x4f & nv::index::Sparse_volume::get_scene_to_object_transform_inverse

(

)

const

Get the transformation matrix to transform from object space to scene space coordinates.

get_volume_bbox_max()

const float3 & nv::index::Sparse_volume::get_volume_bbox_max

(

)

const

Get the sparse volume bounding box maximum coordinate.

---

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

• xac_interface_scene_elements_sparse_volume_doc.h