HDK_Sample::vray_VolumeSphere Class Reference

Volume primitive used by VRAY/VRAY_DemoVolumeSphereC. More...

Inheritance diagram for HDK_Sample::vray_VolumeSphere:

List of all members.

Public Member Functions
virtual void	getWeightedBoxes (UT_RefArray< UT_BoundingBox > &boxes, UT_FloatArray &weights, fpreal radius, fpreal dbound) const
virtual void	getAttributeBinding (UT_StringArray &names, UT_IntArray &sizes) const
virtual void	evaluate (const UT_Vector3 &pos, const UT_Filter &filter, fpreal radius, float time, int idx, float *data) const
virtual UT_Vector3	gradient (const UT_Vector3 &pos, const UT_Filter &filter, fpreal radius, fpreal time, int idx) const

---

Detailed Description

Volume primitive used by VRAY/VRAY_DemoVolumeSphereC.

Examples:

VRAY/VRAY_DemoVolumeSphere.C.

Definition at line 44 of file VRAY_DemoVolumeSphere.C.

---

Member Function Documentation

void vray_VolumeSphere::evaluate	(	const UT_Vector3 &	pos,
		const UT_Filter &	filter,
		fpreal	radius,
		float	time,
		int	idx,
		float *	data
	)			const [virtual]

Evaluate a volume attribute at a given position.

Parameters:

	pos	Evaluation position
	filter	Filter function
	radius	Filter radius in voxels
	time	Evaluation time (0-1)
	idx	Attribute index (based on getAttributeBinding())
	data	Storage for evaluation data

See also:

UT_Filter

Implements VGEO_Volume.

Examples:

VRAY/VRAY_DemoVolumeSphere.C.

Definition at line 95 of file VRAY_DemoVolumeSphere.C.

void vray_VolumeSphere::getAttributeBinding	(	UT_StringArray &	names,
		UT_IntArray &	sizes
	)			const [virtual]

Return a list of attributes present in this volume. These attributes will be bound to surface shader variables when the volume is rendered. The "idx" passed into evaluation routines will be the array index returned by this operation.

• sizes: number of floats in each attribute

Implements VGEO_Volume.

Examples:

VRAY/VRAY_DemoVolumeSphere.C.

Definition at line 79 of file VRAY_DemoVolumeSphere.C.

void vray_VolumeSphere::getWeightedBoxes	(	UT_RefArray< UT_BoundingBox > &	boxes,
		UT_FloatArray &	weights,
		fpreal	radius,
		fpreal	dbound
	)			const [virtual]

Return a set of bounding boxes that define the structure of the volumetric data. Each box has an associated weight, which represents the relative importance of that part of the volume (such as the density). The boxes are used to accelerate intersection testing with the volume and to perform adaptive sampling. They need not be an exact representation of the volume, though more accurate boxes will lead to more efficient renders.

Boxes should be defined locally, and need to incorporate the displacement bound.

• radius: filter radius in voxels
• dbound: displacement bound in local space

Implements VGEO_Volume.

Examples:

VRAY/VRAY_DemoVolumeSphere.C.

Definition at line 66 of file VRAY_DemoVolumeSphere.C.

UT_Vector3 vray_VolumeSphere::gradient	(	const UT_Vector3 &	pos,
		const UT_Filter &	filter,
		fpreal	radius,
		fpreal	time,
		int	idx
	)			const [virtual]

Evaluate the gradient of a volume attribute at a given position.

Parameters:

	pos	Evaluation position
	filter	Filter function
	radius	Filter radius in voxels
	time	Evaluation time (0-1)
	idx	Attribute index (based on getAttributeBinding())

See also:

UT_Filter

Reimplemented from VGEO_Volume.

Examples:

VRAY/VRAY_DemoVolumeSphere.C.

Definition at line 112 of file VRAY_DemoVolumeSphere.C.

---

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

• samples/VRAY/VRAY_DemoVolumeSphere.C