nv::index::xac::Irregular_volume Class Reference

Irregular volume reference class. More...

#include <xac_interface_scene_elements_irregular_volume_doc.h>

Public Types
typedef Sample_info_irregular_volume	Base_info_type
	Declaring a irregular volume sample info. More...

Public Member Functions
xac::Colormap	get_colormap () const
	Get the colormap currently associated with the volume through the scene setup. More...
float3	get_scene_bounding_box_min () const
	Get the irregular volume bounding box minimum coordinate. More...
float3	get_scene_bounding_box_max () const
	Get the irregular volume bounding box maximum coordinate. More...
Irregular_volume_cell_info	generate_cell_sample_info (const Ray &ray, const float ray_t) const
	Generates a local irregular volume cell information based on the view ray and depth. More...
Irregular_volume_cell_info	generate_cell_sample_info (const float3 &scene_position) const
	Generates a local irregular volume cell information based on a sampling position in scene space coordinates. More...
template<typename Attrib_type>
Attrib_type	fetch_attribute (const unsigned attrib_idx, const Irregular_volume_cell_info &cell_info) const
	Sample a irregular volume attribute using a precomputed cell information object. More...
template<typename Attrib_type>
Attrib_type	fetch_attribute_offset (const unsigned attrib_idx, const Irregular_volume_cell_info &cell_info, const float3 &sample_offset_vector) const
	Sample a irregular volume attribute using a precomputed cell information object using a specified spatial offset in scene space coordinates. The offset is added to the sample location store in the cell info reference. More...

Detailed Description

Irregular volume reference class.

Member Typedef Documentation

Base_info_type

typedef Sample_info_irregular_volume nv::index::xac::Irregular_volume::Base_info_type

Declaring a irregular volume sample info.

Member Function Documentation

fetch_attribute()

template<typename Attrib_type>

Attrib_type nv::index::xac::Irregular_volume::fetch_attribute	(	const unsigned	attrib_idx,
		const Irregular_volume_cell_info &	cell_info
	)		const

Sample a irregular volume attribute using a precomputed cell information object.

fetch_attribute_offset()

template<typename Attrib_type>

Attrib_type nv::index::xac::Irregular_volume::fetch_attribute_offset	(	const unsigned	attrib_idx,
		const Irregular_volume_cell_info &	cell_info,
		const float3 &	sample_offset_vector
	)		const

Sample a irregular volume attribute using a precomputed cell information object using a specified spatial offset in scene space coordinates. The offset is added to the sample location store in the cell info reference.

generate_cell_sample_info() [1/2]

Irregular_volume_cell_info nv::index::xac::Irregular_volume::generate_cell_sample_info

(

const float3 &

scene_position

)

const

Generates a local irregular volume cell information based on a sampling position in scene space coordinates.

generate_cell_sample_info() [2/2]

Irregular_volume_cell_info nv::index::xac::Irregular_volume::generate_cell_sample_info	(	const Ray &	ray,
		const float	ray_t
	)		const

Generates a local irregular volume cell information based on the view ray and depth.

get_colormap()

xac::Colormap nv::index::xac::Irregular_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_scene_bounding_box_max()

float3 nv::index::xac::Irregular_volume::get_scene_bounding_box_max

(

)

const

Get the irregular volume bounding box maximum coordinate.

get_scene_bounding_box_min()

float3 nv::index::xac::Irregular_volume::get_scene_bounding_box_min

(

)

const

Get the irregular volume bounding box minimum coordinate.

---

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

• xac_interface_scene_elements_irregular_volume_doc.h