Raytrix Light Field SDK  5.0
Rx::FileIO::CVolWriter Class Reference

Detailed Description

Depth correction volume writer.

Inherits Rx::FileIO::CVol.

Public Member Functions

 CVolWriter ()
 Default constructor. More...
 
 ~CVolWriter ()
 Destructor. More...
 
void Close ()
 Closes this CVolWriter and finalizes the file. More...
 
size_t GetApproximatedFileSize ()
 Gets approximated file size. More...
 
void Open (const CRxString &sxFilename)
 Opens a new file to write. More...
 
void WriteVolume (const CRxMapping3D &xDepthCorrectionVolume)
 Writes the depth correction volume. More...
 

Static Public Member Functions

static const CRxStringGetGuid ()
 Gets the unique identifier of this type. More...
 
static unsigned GetVersion ()
 Gets the version. More...
 

Constructor & Destructor Documentation

◆ CVolWriter()

Rx::FileIO::CVolWriter::CVolWriter ( )

Default constructor.

◆ ~CVolWriter()

Rx::FileIO::CVolWriter::~CVolWriter ( )

Destructor.

Member Function Documentation

◆ Close()

void Rx::FileIO::CVolWriter::Close ( )

Closes this CVolWriter and finalizes the file.

◆ GetApproximatedFileSize()

size_t Rx::FileIO::CVolWriter::GetApproximatedFileSize ( )

Gets approximated file size.

Returns
The approximated file size.

◆ GetGuid()

static const CRxString& Rx::FileIO::CVol::GetGuid ( )
staticinherited

Gets the unique identifier of this type.

Returns
The unique identifier.

◆ GetVersion()

static unsigned Rx::FileIO::CVol::GetVersion ( )
staticinherited

Gets the version.

Returns
The version.

◆ Open()

void Rx::FileIO::CVolWriter::Open ( const CRxString sxFilename)

Opens a new file to write.

After opening a volume file to write the volume content look like that: |<Content> |<Volume> |</Volume> |</Content>

Parameters
sxFilenameThe filename.

◆ WriteVolume()

void Rx::FileIO::CVolWriter::WriteVolume ( const CRxMapping3D xDepthCorrectionVolume)

Writes the depth correction volume.

                                            Dimension X
            Min Position *_________________
                                    /|                                /
                               / |                           /|
                              /__|______________/ |Dimension Y
                              |      |                              | |
                              |      |______________|_|
                              |  /                          | /
      Dimension Z | /                           |/
                              |/________________* MaxPosition

            After writing the volume the XML looks like this:

            <c>
            |<Content>
                    |<Volume>
                            |<MinPosition X="[Double]" Y="[Double]" Z="[Double]"></MinPosition>
                            |<MaxPosition X = "[Double]" Y = "[Double]" Z = "[Double]">< / MaxPosition>
                            |<Dimension X = "[INT]" Y = "[INT]" Z = "[INT]">< / Dimension>
                            |<DepthCorrectionData FilePosition = "[INT64]"  Bytes = "[INT64]"> < / DepthCorrectionData>
                    |</Volume>
            |</Content>
    </c>
Parameters
xDepthCorrectionVolumeThe depth correction data volume.