Open CASCADE Technology  6.9.0
Public Member Functions | Protected Attributes

Voxel_DS Class Reference

A base class for all voxel data structures. More...

#include <Voxel_DS.hxx>

Inheritance diagram for Voxel_DS:
Inheritance graph
[legend]

Public Member Functions

 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...
 
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. The methods below return initial data of the voxel model. 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...
 

Protected Attributes

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 base class for all voxel data structures.

Constructor & Destructor Documentation

Voxel_DS::Voxel_DS ( )

An empty constructor.

Voxel_DS::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.

Member Function Documentation

void Voxel_DS::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).

Standard_Integer Voxel_DS::GetNbX ( ) const
Standard_Integer Voxel_DS::GetNbY ( ) const
Standard_Integer Voxel_DS::GetNbZ ( ) const
void Voxel_DS::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).

Standard_Boolean Voxel_DS::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.

Standard_Boolean Voxel_DS::GetVoxelX ( const Standard_Real  x,
Standard_Integer ix 
) const

Returns x-index of a voxel corresponding to x-coordinate.

Standard_Boolean Voxel_DS::GetVoxelY ( const Standard_Real  y,
Standard_Integer iy 
) const

Returns y-index of a voxel corresponding to y-coordinate.

Standard_Boolean Voxel_DS::GetVoxelZ ( const Standard_Real  z,
Standard_Integer iz 
) const

Returns z-index of a voxel corresponding to z-coordinate.

Standard_Real Voxel_DS::GetX ( ) const
Standard_Real Voxel_DS::GetXLen ( ) const
Standard_Real Voxel_DS::GetY ( ) const
Standard_Real Voxel_DS::GetYLen ( ) const
Standard_Real Voxel_DS::GetZ ( ) const
Standard_Real Voxel_DS::GetZLen ( ) const
virtual void Voxel_DS::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. The methods below return initial data of the voxel model.

Reimplemented in Voxel_OctBoolDS, Voxel_ROctBoolDS, Voxel_BoolDS, Voxel_FloatDS, and Voxel_ColorDS.

Field Documentation

Standard_Address Voxel_DS::myData
protected
Standard_Real Voxel_DS::myDX
protected
Standard_Real Voxel_DS::myDY
protected
Standard_Real Voxel_DS::myDZ
protected
Standard_Real Voxel_DS::myHalfDX
protected
Standard_Real Voxel_DS::myHalfDY
protected
Standard_Real Voxel_DS::myHalfDZ
protected
Standard_Integer Voxel_DS::myNbX
protected
Standard_Integer Voxel_DS::myNbXY
protected
Standard_Integer Voxel_DS::myNbY
protected
Standard_Integer Voxel_DS::myNbZ
protected
Standard_Real Voxel_DS::myX
protected
Standard_Real Voxel_DS::myXLen
protected
Standard_Real Voxel_DS::myY
protected
Standard_Real Voxel_DS::myYLen
protected
Standard_Real Voxel_DS::myZ
protected
Standard_Real Voxel_DS::myZLen
protected

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