nv::index::xac::VDB_volume Class Reference

VDB volume reference class used to represent volumes loaded in the NanoVDB volume format. More...

#include <xac_interface_scene_elements_vdb_volume_doc.h>

Public Types
typedef Sample_info_vdb	Base_info_type
	Declaring the VDB volume sample info. More...

Public Member Functions
template<typename VDB_attrib_type , Volume_filter_mode VDB_filter_mode = default_filter_mode, typename VDB_grid_type = default_grid_type, bool VDB_sampler_use_cache = yes>
VDB_sampler< VDB_attrib_type, VDB_filter_mode, VDB_grid_type, VDB_sampler_use_cache >	generate_sampler (const unsigned attrib_idx=0u) const
	Generates a VDB volume sampler object for a given attribute index. 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 the distance of the current sample with respec to the camera. More...
const float3 &	get_volume_bbox_max () const
	Get the VDB 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...

Detailed Description

VDB volume reference class used to represent volumes loaded in the NanoVDB volume format.

Note that, standard OpenVDB volumes are represented using the default sparse volume scene element.

Member Typedef Documentation

Base_info_type

typedef Sample_info_vdb nv::index::xac::VDB_volume::Base_info_type

Declaring the VDB volume sample info.

Member Function Documentation

generate_sampler()

template<typename VDB_attrib_type , Volume_filter_mode VDB_filter_mode = default_filter_mode, typename VDB_grid_type = default_grid_type, bool VDB_sampler_use_cache = yes>

VDB_sampler< VDB_attrib_type, VDB_filter_mode, VDB_grid_type, VDB_sampler_use_cache > nv::index::xac::VDB_volume::generate_sampler

(

const unsigned

attrib_idx = 0u

)

const

Generates a VDB volume sampler object for a given attribute index.

Note

: The default filter mode and grid type are derived from the filter mode set for the VDB volume scene element through the scene specification. For kernel programs defined for other scene elements the modes have to be specified explicitly.

get_colormap()

xac::Colormap nv::index::xac::VDB_volume::get_colormap

(

)

const

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

Note

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

get_sample_distance()

float nv::index::xac::VDB_volume::get_sample_distance

(

)

const &

Get the distance of the current sample with respec to the camera.

Get the VDB volume bounding box minimum coordinate

get_scene_to_object_transform()

const Mat4x4f & nv::index::xac::VDB_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::xac::VDB_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::xac::VDB_volume::get_volume_bbox_max

(

)

const

Get the VDB volume bounding box maximum coordinate.

---

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

• xac_interface_scene_elements_vdb_volume_doc.h