HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
GEO_IOTable Class Reference

#include <GEO_IOTable.h>

+ Inheritance diagram for GEO_IOTable:

Public Member Functions

 GEO_IOTable ()
 
 GEO_IOTable (const GEO_IOTable &src)
 
virtual ~GEO_IOTable ()
 
virtual GEO_IOTranslatorduplicate () const
 This method is used to create a copy of the sub-class. More...
 
virtual const char * formatName () const
 
virtual int checkExtension (const char *name)
 
virtual int checkMagicNumber (unsigned magic)
 
virtual GA_Detail::IOStatus fileLoad (GEO_Detail *, UT_IStream &, bool ate)
 
virtual GA_Detail::IOStatus fileSave (const GEO_Detail *, std::ostream &)
 
virtual GA_Detail::IOStatus fileSaveToFile (const GEO_Detail *gdp, const char *filename)
 
virtual bool fileStat (const char *filename, GA_Stat &stat, uint level)
 
- Public Member Functions inherited from GEO_IOTranslator
 GEO_IOTranslator ()
 
virtual ~GEO_IOTranslator ()
 
virtual void getFileExtensions (UT_StringArray &extensions) const
 
void eraseDSODefinition ()
 

Static Public Member Functions

static int getSaveFormatCount ()
 Return the number of extensions which can be written to. More...
 
static const char * getSaveFormat (int i)
 Return the Nth save format. More...
 
static int getFormatCount ()
 Return the number of formats loaded from the GEOio table. More...
 
static const char * getFormatDescription (int i)
 
static void getFormatRW (int i, bool &can_read, bool &can_write)
 
static void getFormatExtensions (int i, UT_StringArray &extensions)
 
- Static Public Member Functions inherited from GEO_IOTranslator
static const geo_DSODefinitionsdsoDefinitions ()
 Return the list of DSO based translators. More...
 

Additional Inherited Members

- Public Types inherited from GEO_IOTranslator
typedef UT_StringMap
< UT_StringHolder
geo_DSODefinitions
 
- Protected Member Functions inherited from GEO_IOTranslator
bool statJSONStream (UT_IStream &is, GA_Stat &stat, uint level) const
 Stat a .bgeo JSON stream. More...
 

Detailed Description

Definition at line 24 of file GEO_IOTable.h.

Constructor & Destructor Documentation

GEO_IOTable::GEO_IOTable ( )
inline

Definition at line 27 of file GEO_IOTable.h.

GEO_IOTable::GEO_IOTable ( const GEO_IOTable src)
inline

Definition at line 31 of file GEO_IOTable.h.

virtual GEO_IOTable::~GEO_IOTable ( )
virtual

Member Function Documentation

virtual int GEO_IOTable::checkExtension ( const char *  name)
virtual

Method to check the extension of the name to see if it matches one that we can handle. Returns true if there's a match

Implements GEO_IOTranslator.

virtual int GEO_IOTable::checkMagicNumber ( unsigned  magic)
virtual

Method to check if the given magic number matches the magic number. Return true on a match.

Implements GEO_IOTranslator.

virtual GEO_IOTranslator* GEO_IOTable::duplicate ( ) const
virtual

This method is used to create a copy of the sub-class.

Implements GEO_IOTranslator.

virtual GA_Detail::IOStatus GEO_IOTable::fileLoad ( GEO_Detail gdp,
UT_IStream is,
bool  ate_magic 
)
virtual

Method to load from a stream. If the ate_magic flag is on, then the library has already read the magic number and the loader should not expect it. If the file format doesn't support reading from streams, it can use UT_IStream::isRandomAccessFile to get the raw name to read from. Return false if this translator doesn't support loading.

Implements GEO_IOTranslator.

virtual GA_Detail::IOStatus GEO_IOTable::fileSave ( const GEO_Detail gdp,
std::ostream &  os 
)
virtual

Method to save a gdp to another format. Return false if this translator does not support saving.

Implements GEO_IOTranslator.

virtual GA_Detail::IOStatus GEO_IOTable::fileSaveToFile ( const GEO_Detail gdp,
const char *  filename 
)
virtual

Method to save a gdp to another format via a filename. Return false if this translator does not support saving.

This is an optional method. By default, it will create a stream and call the streaming version of fileSave().

Reimplemented from GEO_IOTranslator.

virtual bool GEO_IOTable::fileStat ( const char *  filename,
GA_Stat stat,
uint  level 
)
virtual

Method to "stat" a file. If possible, stat shouldn't have to load the entire geometry.

Reimplemented from GEO_IOTranslator.

virtual const char* GEO_IOTable::formatName ( ) const
virtual

Returns the label for the geometry format that this translator supports.

Implements GEO_IOTranslator.

static int GEO_IOTable::getFormatCount ( )
static

Return the number of formats loaded from the GEOio table.

static const char* GEO_IOTable::getFormatDescription ( int  i)
static
static void GEO_IOTable::getFormatExtensions ( int  i,
UT_StringArray extensions 
)
static
static void GEO_IOTable::getFormatRW ( int  i,
bool &  can_read,
bool &  can_write 
)
static
static const char* GEO_IOTable::getSaveFormat ( int  i)
static

Return the Nth save format.

static int GEO_IOTable::getSaveFormatCount ( )
static

Return the number of extensions which can be written to.


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