# Visualization
TKV3d
Voxel

# Voxel_ColorDS Class Reference

A 3D voxel model keeping 4 bits for each voxel (one of 16 colors).
.

`#include <Voxel_ColorDS.hxx>`

Inheritance diagram for Voxel_ColorDS:

[legend]

## Public Member Functions

void * | operator new (size_t, void *anAddress)
void * | operator new (size_t size)
void | operator delete (void *anAddress)
Standard_EXPORT | Voxel_ColorDS ()
| An empty constructor. .
Standard_EXPORT | Voxel_ColorDS (const Standard_Real x, const Standard_Real y, const Standard_Real z, const Standard_Real x_len, const Standard_Real y_len, const Standard_Real z_len, const Standard_Integer nb_x, const Standard_Integer nb_y, const Standard_Integer nb_z)
| A constructor initializing the voxel model. (x, y, z) - the start point of the box. (x_len, y_len, z_len) - lengths in x, y and z directions along axes of a co-ordinate system. (nb_x, nb_y, nb_z) - number of splits (voxels) along x, y and z directions. .
virtual Standard_EXPORT void | Init (const Standard_Real x, const Standard_Real y, const Standard_Real z, const Standard_Real x_len, const Standard_Real y_len, const Standard_Real z_len, const Standard_Integer nb_x, const Standard_Integer nb_y, const Standard_Integer nb_z)
| Initialization of the voxel model. (x, y, z) - the start point of the box. (x_len, y_len, z_len) - lengths in x, y and z directions along axes of a co-ordinate system. (nb_x, nb_y, nb_z) - number of splits (voxels) along x, y and z directions. .
Standard_EXPORT void | Destroy ()
| A destructor of the voxel model. .
| ~Voxel_ColorDS ()
Standard_EXPORT void | SetZero ()
| The method sets all values equal to 0 (false) and releases the memory. .
Standard_EXPORT void | Set (const Standard_Integer ix, const Standard_Integer iy, const Standard_Integer iz, const Standard_Byte data)
| Defines a value for voxel with co-ordinates (ix, iy, iz). Only the first four bits are used! Initial state of the model is so that all voxels have value 0x0000, and this data doesn't occupy memory. Memory for data is allocating during setting non-zero values (0x0101, for example). .
Standard_EXPORT Standard_Byte | Get (const Standard_Integer ix, const Standard_Integer iy, const Standard_Integer iz) const
| Returns the value of voxel with co-ordinates (ix, iy, iz). .

## Constructor & Destructor Documentation

Standard_EXPORT Voxel_ColorDS::Voxel_ColorDS | ( |  | ) |

Standard_EXPORT Voxel_ColorDS::Voxel_ColorDS | ( | const Standard_Real | x,
|  | const Standard_Real | y,
|  | const Standard_Real | z,
|  | const Standard_Real | x_len,
|  | const Standard_Real | y_len,
|  | const Standard_Real | z_len,
|  | const Standard_Integer | nb_x,
|  | const Standard_Integer | nb_y,
|  | const Standard_Integer | nb_z
| ) |

Voxel_ColorDS::~Voxel_ColorDS | ( |  | ) | `[inline]`

## Member Function Documentation

Standard_EXPORT void Voxel_ColorDS::Destroy | ( |  | ) |

Standard_EXPORT Standard_Byte Voxel_ColorDS::Get | ( | const Standard_Integer | ix,
|  | const Standard_Integer | iy,
|  | const Standard_Integer | iz
| ) | const

virtual Standard_EXPORT void Voxel_ColorDS::Init | ( | const Standard_Real | x,
|  | const Standard_Real | y,
|  | const Standard_Real | z,
|  | const Standard_Real | x_len,
|  | const Standard_Real | y_len,
|  | const Standard_Real | z_len,
|  | const Standard_Integer | nb_x,
|  | const Standard_Integer | nb_y,
|  | const Standard_Integer | nb_z
| ) | `[virtual]`

| Reimplemented from Voxel_DS.

void Voxel_ColorDS::operator delete | ( | void * | anAddress | ) | `[inline]`

| Reimplemented from Voxel_DS.

void* Voxel_ColorDS::operator new | ( | size_t | size | ) | `[inline]`

| Reimplemented from Voxel_DS.

void* Voxel_ColorDS::operator new | ( | size_t | ,
|  | void * | anAddress
| ) | `[inline]`

| Reimplemented from Voxel_DS.

Standard_EXPORT void Voxel_ColorDS::Set | ( | const Standard_Integer | ix,
|  | const Standard_Integer | iy,
|  | const Standard_Integer | iz,
|  | const Standard_Byte | data
| ) |

Standard_EXPORT void Voxel_ColorDS::SetZero | ( |  | ) |

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

- Voxel_ColorDS.hxx