RixRIB Class Reference

#include <RixRIB.h>

Inherits RixInterface.

Classes
struct	Configuration

Public Types
enum	Type {   k_Float, k_Integer, k_StringV, k_Color,   k_Normal, k_Vector, k_Point, k_HPoint,   k_MPoint, k_Matrix }

Public Member Functions
virtual Ri *	CreateRIBGenerator (Ri *parent=0L, Configuration *config=nullptr)=0
	Return a pointer to RIB generator, or NULL of there is an error. More...
virtual void	DestroyRIBGenerator (Ri *)=0
	Destructs a RIB generator created by CreateRIBGenerator() More...
virtual RixZipWriter *	GetZipWriter (void)=0
	Return the current zip file writer object. More...
virtual RixZipSubfile *	OpenSubfileForRead (const char *path, const char *subfileName)=0
	Return a new zip subfile for read-only purposes. More...
virtual bool	GetBound (const char *archiveName, RtBound bound)=0
	Get the bounding box of the given RIB archive file. More...
virtual int	GetVersion () const
	Get the version number of this interface. More...

Protected Member Functions
	RixRIB ()
	Constructor is for internal use only. More...

Protected Attributes
int	m_version
	Version number of this interface. More...

Member Enumeration Documentation

Type

enum RixInterface::Type

inherited

Enumerator
k_Float
k_Integer
k_StringV
k_Color
k_Normal
k_Vector
k_Point
k_HPoint
k_MPoint
k_Matrix

Constructor & Destructor Documentation

RixRIB()

RixRIB::RixRIB ( )

inlineprotected

Constructor is for internal use only.

Member Function Documentation

CreateRIBGenerator()

virtual Ri* RixRIB::CreateRIBGenerator ( Ri *  parent = 0L, Configuration *  config = nullptr  )

pure virtual

Return a pointer to RIB generator, or NULL of there is an error.

If parent is non-NULL the RIB generator created will share the binary encoding and symbol table of the parent generator.

DestroyRIBGenerator()

virtual void RixRIB::DestroyRIBGenerator ( Ri *  )

pure virtual

Destructs a RIB generator created by CreateRIBGenerator()

GetBound()

virtual bool RixRIB::GetBound ( const char *  archiveName, RtBound  bound  )

pure virtual

Get the bounding box of the given RIB archive file.

Returns true if the bbox is encoded in the RIB file, false otherwise.

GetVersion()

virtual int RixInterface::GetVersion ( ) const

inlinevirtualinherited

Get the version number of this interface.

Different interfaces might have different version numbers in a given release.

References RixInterface::m_version.

GetZipWriter()

virtual RixZipWriter* RixRIB::GetZipWriter ( void  )

pure virtual

Return the current zip file writer object.

Which can be further asked for a new writeable subfile

OpenSubfileForRead()

virtual RixZipSubfile* RixRIB::OpenSubfileForRead ( const char *  path, const char *  subfileName  )

pure virtual

Return a new zip subfile for read-only purposes.

path is the name of the file on disk. subFileName is the name of the subfile within the zip file. There is no RixZipReader object.

Member Data Documentation

m_version

int RixInterface::m_version

protectedinherited

Version number of this interface.

Referenced by RixInterface::GetVersion().

---

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

• RixRIB.h