HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HAPI_VolumeInfo Struct Reference

#include <HAPI_Common.h>

Public Attributes

HAPI_StringHandle nameSH
 
HAPI_VolumeType type
 
int tupleSize
 
HAPI_StorageType storage
 Can be either HAPI_STORAGETYPE_INT or HAPI_STORAGETYPE_FLOAT. More...
 
int tileSize
 
HAPI_Transform transform
 
HAPI_Bool hasTaper
 
int xLength
 
int yLength
 
int zLength
 
int minX
 
int minY
 
int minZ
 
float xTaper
 
float yTaper
 

Detailed Description

This represents a volume primitive but does not contain the actual voxel values, which can be retrieved on a per-tile basis.

See HAPI_Volumes.

Definition at line 1815 of file HAPI_Common.h.

Member Data Documentation

HAPI_Bool HAPI_VolumeInfo::hasTaper

Denotes special situations where the volume tiles are not perfect cubes, but are tapered instead.

Definition at line 1850 of file HAPI_Common.h.

int HAPI_VolumeInfo::minX

Each voxel is identified with an index. The indices will range between: [ ( minX, minY, minZ ), ( minX+xLength, minY+yLength, minZ+zLength ) )

Definition at line 1828 of file HAPI_Common.h.

int HAPI_VolumeInfo::minY

Each voxel is identified with an index. The indices will range between: [ ( minX, minY, minZ ), ( minX+xLength, minY+yLength, minZ+zLength ) )

Definition at line 1829 of file HAPI_Common.h.

int HAPI_VolumeInfo::minZ

Each voxel is identified with an index. The indices will range between: [ ( minX, minY, minZ ), ( minX+xLength, minY+yLength, minZ+zLength ) )

Definition at line 1830 of file HAPI_Common.h.

HAPI_StringHandle HAPI_VolumeInfo::nameSH

Definition at line 1817 of file HAPI_Common.h.

HAPI_StorageType HAPI_VolumeInfo::storage

Can be either HAPI_STORAGETYPE_INT or HAPI_STORAGETYPE_FLOAT.

Definition at line 1838 of file HAPI_Common.h.

int HAPI_VolumeInfo::tileSize

The dimensions of each tile. This can be 8 or 16, denoting an 8x8x8 or 16x16x16 tiles.

Definition at line 1842 of file HAPI_Common.h.

HAPI_Transform HAPI_VolumeInfo::transform

The transform of the volume with respect to the lengths. The volume may be positioned anywhere in space.

Definition at line 1846 of file HAPI_Common.h.

int HAPI_VolumeInfo::tupleSize

Number of values per voxel. The tuple size field is 1 for scalars and 3 for vector data.

Definition at line 1835 of file HAPI_Common.h.

HAPI_VolumeType HAPI_VolumeInfo::type

Definition at line 1819 of file HAPI_Common.h.

int HAPI_VolumeInfo::xLength

Each voxel is identified with an index. The indices will range between: [ ( minX, minY, minZ ), ( minX+xLength, minY+yLength, minZ+zLength ) )

Definition at line 1825 of file HAPI_Common.h.

float HAPI_VolumeInfo::xTaper

If there is taper involved, denotes the amount of taper involved.

Definition at line 1854 of file HAPI_Common.h.

int HAPI_VolumeInfo::yLength

Each voxel is identified with an index. The indices will range between: [ ( minX, minY, minZ ), ( minX+xLength, minY+yLength, minZ+zLength ) )

Definition at line 1826 of file HAPI_Common.h.

float HAPI_VolumeInfo::yTaper

If there is taper involved, denotes the amount of taper involved.

Definition at line 1855 of file HAPI_Common.h.

int HAPI_VolumeInfo::zLength

Each voxel is identified with an index. The indices will range between: [ ( minX, minY, minZ ), ( minX+xLength, minY+yLength, minZ+zLength ) )

Definition at line 1827 of file HAPI_Common.h.


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