FVVLib  1.0.0 beta 4
Classes | Typedefs | Enumerations
fvv Namespace Reference

Classes

struct  FVVFileVersion
 Structure containing the major, minor and maintenance version numbers of a FVV file. More...
struct  FVVPlaytime
 Structure containing the total playtime for the given frames per second and number of frames in a FVV file. More...
struct  FVVMetadata
 Describes metadata as key-value pairs. More...
class  FVVFileInfo
 Interface to access FVV file metadata. More...
class  FVVMultiCameraImageData
 Interface to access multi-camera image data. More...
class  FVVMeshData
 Interface to access indexed indexed triangle set mesh data. More...
class  FVVFrameData
 Interface to access FVV frame data. More...
class  FVVImageInfo
 Interface to access image metadata information. More...
class  FVVCameraInfo
 Interface to access camera calibration information from the capture cameras. More...
class  FVVMultiCameraInfo
 Interface to access multi-camera metadata information. More...
class  FVVFrameInfo
 Interface to access frame metadata information. More...
class  FVVInfo
 Interface to access FVV metadata information. More...
class  FVVLoader
 Central class to access FVV file data. More...

Typedefs

typedef shared_ptr< FVVFileInfoFVVFileInfoPtr
typedef shared_ptr
< FVVMultiCameraImageData
FVVMultiCameraImageDataPtr
typedef shared_ptr< FVVMeshDataFVVMeshDataPtr
typedef shared_ptr< FVVFrameDataFVVFrameDataPtr
typedef shared_ptr< FVVImageInfoFVVImageInfoPtr
typedef shared_ptr< FVVCameraInfoFVVCameraInfoPtr
typedef shared_ptr
< FVVMultiCameraInfo
FVVMultiCameraInfoPtr
typedef shared_ptr< FVVFrameInfoFVVFrameInfoPtr
typedef shared_ptr< FVVInfoFVVInfoPtr
typedef shared_ptr< FVVLoaderFVVLoaderPtr

Enumerations

enum  FVVBaseUnit { FVV_BASE_UNIT_UNDEFINED = 0, FVV_BASE_UNIT_MILLIMETER, FVV_BASE_UNIT_CENTIMETER, FVV_BASE_UNIT_METER }
 Set of possible base units for camera calibration and geometry data. More...
enum  FVVWorldUpAxis {
  FVV_WORLD_UP_AXIS_UNDEFINED = 0, FVV_WORLD_UP_AXIS_POSITIVE_X, FVV_WORLD_UP_AXIS_NEGATIVE_X, FVV_WORLD_UP_AXIS_POSITIVE_Y,
  FVV_WORLD_UP_AXIS_NEGATIVE_Y, FVV_WORLD_UP_AXIS_POSITIVE_Z, FVV_WORLD_UP_AXIS_NEGATIVE_Z
}
 Enumerator for the world coordinate frame up-axis. More...
enum  FVVGeometryFormat { FVV_GEOMETRY_FORMAT_NONE = 0, FVV_GEOMETRY_FORMAT_MESH }
 Set of supported geometry formats in the FVV file. More...
enum  FVVTextureFormat { FVV_TEXTURE_FORMAT_NONE = 0, FVV_TEXTURE_FORMAT_MULTI_CAMERA_IMAGES, FVV_SINGLE_TEXTURE_IMAGE }
 Set of supported texture formats in the FVV file. More...
enum  FVVResult {
  FVV_OK = 0, FVV_ERROR_FILE_OPEN, FVV_ERROR_FILE_FORMAT, FVV_ERROR_FILE_VERSION,
  FVV_ERROR_FILE_READ, FVV_ERROR_FRAME_SEEK, FVV_ERROR_FRAME_DECODING, FVV_ERROR_END_OF_SEQUENCE,
  FVV_ERROR_INVALID_OPERATION, FVV_ERROR_INVALID_PARAMETER
}
 Set of possible error codes returned by every FVVLib function. More...

Typedef Documentation

typedef shared_ptr<FVVFileInfo> FVVFileInfoPtr
typedef shared_ptr<FVVMeshData> FVVMeshDataPtr
typedef shared_ptr<FVVFrameData> FVVFrameDataPtr
typedef shared_ptr<FVVImageInfo> FVVImageInfoPtr
typedef shared_ptr<FVVCameraInfo> FVVCameraInfoPtr
typedef shared_ptr<FVVFrameInfo> FVVFrameInfoPtr
typedef shared_ptr<FVVInfo> FVVInfoPtr
typedef shared_ptr<FVVLoader> FVVLoaderPtr

Enumeration Type Documentation

Set of possible base units for camera calibration and geometry data.

Enumerator:
FVV_BASE_UNIT_UNDEFINED 

No base unit defined.

FVV_BASE_UNIT_MILLIMETER 

Base unit is milimeter.

FVV_BASE_UNIT_CENTIMETER 

Base unit is centimeter.

FVV_BASE_UNIT_METER 

Base unit is meter.

Enumerator for the world coordinate frame up-axis.

Enumerator:
FVV_WORLD_UP_AXIS_UNDEFINED 

No world up-axis defined.

FVV_WORLD_UP_AXIS_POSITIVE_X 

Positive x-axis is world up-axis.

FVV_WORLD_UP_AXIS_NEGATIVE_X 

Negative x-axis is world up-axis.

FVV_WORLD_UP_AXIS_POSITIVE_Y 

Positive y-axis is world up-axis.

FVV_WORLD_UP_AXIS_NEGATIVE_Y 

Negative y-axis is world up-axis.

FVV_WORLD_UP_AXIS_POSITIVE_Z 

Positive z-axis is world up-axis.

FVV_WORLD_UP_AXIS_NEGATIVE_Z 

Negative z-axis is world up-axis.

Set of supported geometry formats in the FVV file.

Enumerator:
FVV_GEOMETRY_FORMAT_NONE 

No geometry data in file.

FVV_GEOMETRY_FORMAT_MESH 

Indexed triangle set mesh data in file.

Set of supported texture formats in the FVV file.

Enumerator:
FVV_TEXTURE_FORMAT_NONE 

No texture data in file.

FVV_TEXTURE_FORMAT_MULTI_CAMERA_IMAGES 

Image data for each capture camera.

FVV_SINGLE_TEXTURE_IMAGE 
enum FVVResult

Set of possible error codes returned by every FVVLib function.

Enumerator:
FVV_OK 

No error.

FVV_ERROR_FILE_OPEN 

Error opening the file, e.g. invalid path.

FVV_ERROR_FILE_FORMAT 

File format error, e.g. non-FVV file or empty file.

FVV_ERROR_FILE_VERSION 

Unsupported FVV file version.

FVV_ERROR_FILE_READ 

Error reading the FVV file, e.g. truncated, corrupted or inconsistent file data.

FVV_ERROR_FRAME_SEEK 

Error seeking for frame in the file.

FVV_ERROR_FRAME_DECODING 

Error while decoding frame data.

FVV_ERROR_END_OF_SEQUENCE 

Operation failed because loader reached the end of the frame sequence.

FVV_ERROR_INVALID_OPERATION 

Invalid usage of the interface, e.g. start frame processing without opening a file first or opening another file without closing the old file first.

FVV_ERROR_INVALID_PARAMETER 

An invalid paramter was passed to the function.