Open CASCADE Technology  6.9.0
Public Member Functions

Voxel_FloatDS Class Reference

A 3D voxel model keeping a foating-point value for each voxel. More...

#include <Voxel_FloatDS.hxx>

Inheritance diagram for Voxel_FloatDS:
Inheritance graph
[legend]

Public Member Functions

 Voxel_FloatDS ()
 An empty constructor. More...
 
 Voxel_FloatDS (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. More...
 
virtual 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. More...
 
void Destroy ()
 A destructor of the voxel model. More...
 
 ~Voxel_FloatDS ()
 
void SetZero ()
 The method sets all values equal to 0 (false) and releases the memory. More...
 
void Set (const Standard_Integer ix, const Standard_Integer iy, const Standard_Integer iz, const Standard_ShortReal data)
 Defines a value for voxel with co-ordinates (ix, iy, iz). Initial state of the model is so that all voxels have value 0.0f, and this data doesn't occupy memory. Memory for data is allocating during setting non-zero values. More...
 
Standard_ShortReal 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). More...
 
- Public Member Functions inherited from Voxel_DS
 Voxel_DS ()
 An empty constructor. More...
 
 Voxel_DS (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. More...
 
Standard_Real GetX () const
 
Standard_Real GetY () const
 
Standard_Real GetZ () const
 
Standard_Real GetXLen () const
 
Standard_Real GetYLen () const
 
Standard_Real GetZLen () const
 
Standard_Integer GetNbX () const
 
Standard_Integer GetNbY () const
 
Standard_Integer GetNbZ () const
 
void GetCenter (const Standard_Integer ix, const Standard_Integer iy, const Standard_Integer iz, Standard_Real &xc, Standard_Real &yc, Standard_Real &zc) const
 Returns the center point of a voxel with co-ordinates (ix, iy, iz). More...
 
void GetOrigin (const Standard_Integer ix, const Standard_Integer iy, const Standard_Integer iz, Standard_Real &x0, Standard_Real &y0, Standard_Real &z0) const
 Returns the origin point of a voxel with co-ordinates (ix, iy, iz). More...
 
Standard_Boolean GetVoxel (const Standard_Real x, const Standard_Real y, const Standard_Real z, Standard_Integer &ix, Standard_Integer &iy, Standard_Integer &iz) const
 Finds a voxel corresponding to a 3D point. Returns true if it is found. More...
 
Standard_Boolean GetVoxelX (const Standard_Real x, Standard_Integer &ix) const
 Returns x-index of a voxel corresponding to x-coordinate. More...
 
Standard_Boolean GetVoxelY (const Standard_Real y, Standard_Integer &iy) const
 Returns y-index of a voxel corresponding to y-coordinate. More...
 
Standard_Boolean GetVoxelZ (const Standard_Real z, Standard_Integer &iz) const
 Returns z-index of a voxel corresponding to z-coordinate. More...
 

Additional Inherited Members

- Protected Attributes inherited from Voxel_DS
Standard_Address myData
 
Standard_Real myX
 
Standard_Real myY
 
Standard_Real myZ
 
Standard_Real myXLen
 
Standard_Real myYLen
 
Standard_Real myZLen
 
Standard_Integer myNbX
 
Standard_Integer myNbY
 
Standard_Integer myNbZ
 
Standard_Integer myNbXY
 
Standard_Real myDX
 
Standard_Real myDY
 
Standard_Real myDZ
 
Standard_Real myHalfDX
 
Standard_Real myHalfDY
 
Standard_Real myHalfDZ
 

Detailed Description

A 3D voxel model keeping a foating-point value for each voxel.

Constructor & Destructor Documentation

Voxel_FloatDS::Voxel_FloatDS ( )

An empty constructor.

Voxel_FloatDS::Voxel_FloatDS ( 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.

Voxel_FloatDS::~Voxel_FloatDS ( )
inline

Member Function Documentation

void Voxel_FloatDS::Destroy ( )

A destructor of the voxel model.

Standard_ShortReal Voxel_FloatDS::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).

virtual void Voxel_FloatDS::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

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.

Reimplemented from Voxel_DS.

void Voxel_FloatDS::Set ( const Standard_Integer  ix,
const Standard_Integer  iy,
const Standard_Integer  iz,
const Standard_ShortReal  data 
)

Defines a value for voxel with co-ordinates (ix, iy, iz). Initial state of the model is so that all voxels have value 0.0f, and this data doesn't occupy memory. Memory for data is allocating during setting non-zero values.

void Voxel_FloatDS::SetZero ( )

The method sets all values equal to 0 (false) and releases the memory.


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