IMG_DeepShadowChannel Class Reference

Single channel of a Houdini DSM image. More...

#include <IMG_DeepShadow.h>

List of all members.

Public Member Functions
	IMG_DeepShadowChannel (const char *name, int float_offset, int tuple_size, const char *storage="real32")
	IMG_DeepShadowChannel (const IMG_DeepShadowChannel &src)
	Copy constructor.
	~IMG_DeepShadowChannel ()
IMG_DeepShadowChannel &	operator= (const IMG_DeepShadowChannel &s)
bool	operator== (const IMG_DeepShadowChannel &s) const
const char *	getName () const
const char *	getStorage () const
int	getOffset () const
int	getTupleSize () const

---

Detailed Description

Single channel of a Houdini DSM image.

A Houdini deep shadow/camera file can have any number of image channels (planes). A DSM image contains a single channel for opacity. A deep camera image has the opacity channel along with any number of extra image channels.

Examples:

standalone/dsmprint.C.

Definition at line 113 of file IMG_DeepShadow.h.

---

Constructor & Destructor Documentation

IMG_DeepShadowChannel::IMG_DeepShadowChannel	(	const char *	name,
		int	float_offset,
		int	tuple_size,
		const char *	storage = "real32"
	)

Parameters:

	name	The unique name of the DSM channel
	float_offset	When data is read or written in deep shadow files, the pixel data is interleaved. That is, the data for a single pixel can be represented as an array of floats. Each channel has a unique offset into the array. The user should not assume that the offsets are contiguous. For example, the pixel data might look like: [ Of.r, // Opacity red Of.g, // Opacity green Of.b, // Opacity blue Cf.r, // Color (red) Cf.g, // Color (green) Cf.b, // Color (blue) s, // s coordinate t, // t coordinate N.x, // Normal x N.y, // Normal y N.z, // Normal z ] Where the channels would be defined by: IMG_DeepShadowChannel("Of", 0, 3); IMG_DeepShadowChannel("Cf", 3, 3); IMG_DeepShadowChannel("s", 6, 1); IMG_DeepShadowChannel("t", 7, 1); IMG_DeepShadowChannel("N", 8, 3);
	tuple_size	Number of floats
	storage	Storage type. This may be one of { "real16", "real32", "real64" }. This value represents the storage of the channel in the file.

See also:

IMG_DeepShadow::addExtraChannel()

IMG_DeepShadowChannel::IMG_DeepShadowChannel

(

const IMG_DeepShadowChannel &

src

)

Copy constructor.

IMG_DeepShadowChannel::~IMG_DeepShadowChannel

(

)

---

Member Function Documentation

const char* IMG_DeepShadowChannel::getName

(

void

)

const [inline]

Data acceess function

Examples:

standalone/dsmprint.C.

Definition at line 162 of file IMG_DeepShadow.h.

int IMG_DeepShadowChannel::getOffset

(

)

const [inline]

Data acceess function

Definition at line 164 of file IMG_DeepShadow.h.

const char* IMG_DeepShadowChannel::getStorage

(

)

const [inline]

Data acceess function

Definition at line 163 of file IMG_DeepShadow.h.

int IMG_DeepShadowChannel::getTupleSize

(

)

const [inline]

Data acceess function

Examples:

standalone/dsmprint.C.

Definition at line 165 of file IMG_DeepShadow.h.

IMG_DeepShadowChannel& IMG_DeepShadowChannel::operator=

(

const IMG_DeepShadowChannel &

s

)

bool IMG_DeepShadowChannel::operator==

(

const IMG_DeepShadowChannel &

s

)

const

---

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

• IMG/IMG_DeepShadow.h