QD3DIO.h

Go to the documentation of this file.

 
#ifndef __QD3DIO__
#define __QD3DIO__
 
#ifndef __QD3D__
#include <QD3D.h>
#endif
 
#ifndef __QD3DDRAWCONTEXT__
#include <QD3DDrawContext.h>
#endif
 
#ifndef __QD3DVIEW__
#include <QD3DView.h>
#endif
 
#if PRAGMA_ONCE
#pragma once
#endif
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#if PRAGMA_IMPORT
#pragma import on
#endif
 
#if PRAGMA_STRUCT_ALIGN
#pragma options align = power
#elif PRAGMA_STRUCT_PACKPUSH
#pragma pack(push, 2)
#elif PRAGMA_STRUCT_PACK
#pragma pack(2)
#endif
 
#if PRAGMA_ENUM_ALWAYSINT
#if defined(__fourbyteints__) && !__fourbyteints__
#define __QD3DIO__RESTORE_TWOBYTEINTS
#pragma fourbyteints on
#endif
#pragma enumsalwaysint on
#elif PRAGMA_ENUM_OPTIONS
#pragma option enum =int
#elif PRAGMA_ENUM_PACK
#if __option(pack_enums)
#define __QD3DIO__RESTORE_PACKED_ENUMS
#pragma options(!pack_enums)
#endif
#endif
 
  /*******************************************************************************
   **                                                                          **
   **                                 Basic Types                              **
   **                                                                          **
   *****************************************************************************/
  typedef unsigned char TQ3Uns8;
  typedef signed char TQ3Int8;
  typedef unsigned short TQ3Uns16;
  typedef signed short TQ3Int16;
  typedef unsigned long TQ3Uns32;
  typedef signed long TQ3Int32;
#if TARGET_RT_BIG_ENDIAN
  struct TQ3Uns64
  {
    unsigned long hi;
    unsigned long lo;
  };
  typedef struct TQ3Uns64 TQ3Uns64;
  struct TQ3Int64
  {
    signed long hi;
    unsigned long lo;
  };
  typedef struct TQ3Int64 TQ3Int64;
#else
struct TQ3Uns64
{
  unsigned long lo;
  unsigned long hi;
};
typedef struct TQ3Uns64 TQ3Uns64;
struct TQ3Int64
{
  unsigned long lo;
  signed long hi;
};
typedef struct TQ3Int64 TQ3Int64;
#endif 
  typedef float TQ3Float32;
  typedef double TQ3Float64;
  typedef TQ3Uns32 TQ3Size;
  /*******************************************************************************
   **                                                                          **
   **                                 File Types                               **
   **                                                                          **
   *****************************************************************************/
  enum TQ3FileModeMasks
  {
    kQ3FileModeNormal = 0,
    kQ3FileModeStream = 1 << 0,
    kQ3FileModeDatabase = 1 << 1,
    kQ3FileModeText = 1 << 2
  };
  typedef enum TQ3FileModeMasks TQ3FileModeMasks;
 
  typedef unsigned long TQ3FileMode;
  /*******************************************************************************
   **                                                                          **
   **                                 Method Types                             **
   **                                                                          **
   *****************************************************************************/
  enum
  {
    kQ3XMethodTypeObjectFileVersion = FOUR_CHAR_CODE('vers'),  
    kQ3XMethodTypeObjectTraverse = FOUR_CHAR_CODE('trvs'),     
    kQ3XMethodTypeObjectTraverseData = FOUR_CHAR_CODE('trvd'), 
    kQ3XMethodTypeObjectWrite = FOUR_CHAR_CODE('writ'),        
    kQ3XMethodTypeObjectReadData =
        FOUR_CHAR_CODE('rddt'), 
    kQ3XMethodTypeObjectRead = FOUR_CHAR_CODE('read'),
    kQ3XMethodTypeObjectAttach = FOUR_CHAR_CODE('attc')
  };
 
  typedef CALLBACK_API_C(TQ3Status, TQ3XObjectTraverseMethod)(TQ3Object object,
                                                              void *data,
                                                              TQ3ViewObject view);
  typedef CALLBACK_API_C(TQ3Status,
                         TQ3XObjectTraverseDataMethod)(TQ3Object object,
                                                       void *data,
                                                       TQ3ViewObject view);
  typedef CALLBACK_API_C(TQ3Status, TQ3XObjectWriteMethod)(const void *object,
                                                           TQ3FileObject theFile);
  typedef CALLBACK_API_C(void, TQ3XDataDeleteMethod)(void *data);
#if CALL_NOT_IN_CARBON
  TQ3Status
  Q3XView_SubmitWriteData(TQ3ViewObject view, TQ3Size size, void *data,
                          TQ3XDataDeleteMethod deleteData);
 
  TQ3Status
  Q3XView_SubmitSubObjectData(TQ3ViewObject view, TQ3XObjectClass objectClass,
                              unsigned long size, void *data,
                              TQ3XDataDeleteMethod deleteData);
 
#endif 
  typedef CALLBACK_API_C(TQ3Object, TQ3XObjectReadMethod)(TQ3FileObject theFile);
  typedef CALLBACK_API_C(TQ3Status,
                         TQ3XObjectReadDataMethod)(TQ3Object parentObject,
                                                   TQ3FileObject theFile);
  typedef CALLBACK_API_C(TQ3Status,
                         TQ3XObjectAttachMethod)(TQ3Object childObject,
                                                 TQ3Object parentObject);
 
  /*******************************************************************************
   **                                                                          **
   **                             Versioning                                   **
   **                                                                          **
   *****************************************************************************/
 
#define Q3FileVersion(majorVersion, minorVersion)              \
  (TQ3FileVersion)((((TQ3Uns32)majorVersion & 0xFFFF) << 16) | \
                   ((TQ3Uns32)minorVersion & 0xFFFF))
 
  typedef unsigned long TQ3FileVersion;
#define kQ3FileVersionCurrent Q3FileVersion(1, 6)
 
/*******************************************************************************
 **                                                                          **
 **                             File Routines                                **
 **                                                                          **
 *****************************************************************************/
#if CALL_NOT_IN_CARBON
  TQ3FileObject
  Q3File_New(void);
 
  TQ3Status
  Q3File_GetStorage(TQ3FileObject theFile, TQ3StorageObject *storage);
 
  TQ3Status
  Q3File_SetStorage(TQ3FileObject theFile, TQ3StorageObject storage);
 
  TQ3Status
  Q3File_OpenRead(TQ3FileObject theFile, TQ3FileMode *mode);
 
  TQ3Status
  Q3File_OpenWrite(TQ3FileObject theFile, TQ3FileMode mode);
 
  TQ3Status
  Q3File_IsOpen(TQ3FileObject theFile, TQ3Boolean *isOpen);
 
  TQ3Status
  Q3File_GetMode(TQ3FileObject theFile, TQ3FileMode *mode);
 
  TQ3Status
  Q3File_GetVersion(TQ3FileObject theFile, TQ3FileVersion *version);
 
  TQ3Status
  Q3File_Close(TQ3FileObject theFile);
 
  TQ3Status
  Q3File_Cancel(TQ3FileObject theFile);
 
  TQ3Status
  Q3View_StartWriting(TQ3ViewObject view, TQ3FileObject theFile);
 
  TQ3ViewStatus
  Q3View_EndWriting(TQ3ViewObject view);
 
  TQ3ObjectType
  Q3File_GetNextObjectType(TQ3FileObject theFile);
 
  TQ3Boolean
  Q3File_IsNextObjectOfType(TQ3FileObject theFile, TQ3ObjectType ofType);
 
  TQ3Object
  Q3File_ReadObject(TQ3FileObject theFile);
 
  TQ3Status
  Q3File_SkipObject(TQ3FileObject theFile);
 
  TQ3Boolean
  Q3File_IsEndOfData(TQ3FileObject theFile);
 
  TQ3Boolean
  Q3File_IsEndOfContainer(TQ3FileObject theFile, TQ3Object rootObject);
 
  TQ3Boolean
  Q3File_IsEndOfFile(TQ3FileObject theFile);
 
  TQ3Status
  Q3File_MarkAsExternalReference(TQ3FileObject theFile,
                                 TQ3SharedObject sharedObject);
 
  TQ3GroupObject
  Q3File_GetExternalReferences(TQ3FileObject theFile);
 
  TQ3Status
  Q3Shared_ClearEditTracking(TQ3SharedObject sharedObject);
 
  TQ3Boolean
  Q3Shared_GetEditTrackingState(TQ3SharedObject sharedObject);
 
#endif 
  enum TQ3FileReadGroupStateMasks
  {
    kQ3FileReadWholeGroup = 0,
    kQ3FileReadObjectsInGroup = 1 << 0,
    kQ3FileCurrentlyInsideGroup = 1 << 1
  };
  typedef enum TQ3FileReadGroupStateMasks TQ3FileReadGroupStateMasks;
 
  typedef unsigned long TQ3FileReadGroupState;
#if CALL_NOT_IN_CARBON
  TQ3Status
  Q3File_SetReadInGroup(TQ3FileObject theFile,
                        TQ3FileReadGroupState readGroupState);
 
  TQ3Status
  Q3File_GetReadInGroup(TQ3FileObject theFile,
                        TQ3FileReadGroupState *readGroupState);
 
#endif 
  typedef CALLBACK_API_C(TQ3Status, TQ3FileIdleMethod)(TQ3FileObject theFile,
                                                       const void *idlerData);
#if CALL_NOT_IN_CARBON
  TQ3Status
  Q3File_SetIdleMethod(TQ3FileObject theFile, TQ3FileIdleMethod idle,
                       const void *idleData);
 
  /*******************************************************************************
   **                                                                          **
   **                             Primitives Routines                          **
   **                                                                          **
   *****************************************************************************/
  TQ3Status
  Q3NewLine_Write(TQ3FileObject theFile);
 
  TQ3Status
  Q3Uns8_Read(TQ3Uns8 *data, TQ3FileObject theFile);
 
  TQ3Status
  Q3Uns8_Write(TQ3Uns8 data, TQ3FileObject theFile);
 
  TQ3Status
  Q3Uns16_Read(TQ3Uns16 *data, TQ3FileObject theFile);
 
  TQ3Status
  Q3Uns16_Write(TQ3Uns16 data, TQ3FileObject theFile);
 
  TQ3Status
  Q3Uns32_Read(TQ3Uns32 *data, TQ3FileObject theFile);
 
  TQ3Status
  Q3Uns32_Write(TQ3Uns32 data, TQ3FileObject theFile);
 
  TQ3Status
  Q3Int8_Read(TQ3Int8 *data, TQ3FileObject theFile);
 
  TQ3Status
  Q3Int8_Write(TQ3Int8 data, TQ3FileObject theFile);
 
  TQ3Status
  Q3Int16_Read(TQ3Int16 *data, TQ3FileObject theFile);
 
  TQ3Status
  Q3Int16_Write(TQ3Int16 data, TQ3FileObject theFile);
 
  TQ3Status
  Q3Int32_Read(TQ3Int32 *data, TQ3FileObject theFile);
 
  TQ3Status
  Q3Int32_Write(TQ3Int32 data, TQ3FileObject theFile);
 
  TQ3Status
  Q3Uns64_Read(TQ3Uns64 *data, TQ3FileObject theFile);
 
  TQ3Status
  Q3Uns64_Write(TQ3Uns64 data, TQ3FileObject theFile);
 
  TQ3Status
  Q3Int64_Read(TQ3Int64 *data, TQ3FileObject theFile);
 
  TQ3Status
  Q3Int64_Write(TQ3Int64 data, TQ3FileObject theFile);
 
  TQ3Status
  Q3Float32_Read(TQ3Float32 *data, TQ3FileObject theFile);
 
  TQ3Status
  Q3Float32_Write(TQ3Float32 data, TQ3FileObject theFile);
 
  TQ3Status
  Q3Float64_Read(TQ3Float64 *data, TQ3FileObject theFile);
 
  TQ3Status
  Q3Float64_Write(TQ3Float64 data, TQ3FileObject theFile);
 
  TQ3Size
  Q3Size_Pad(TQ3Size size);
 
  TQ3Status
  Q3String_Read(char *data, unsigned long *length, TQ3FileObject theFile);
 
  TQ3Status
  Q3String_Write(const char *data, TQ3FileObject theFile);
 
  TQ3Status
  Q3RawData_Read(unsigned char *data, unsigned long size, TQ3FileObject theFile);
 
  TQ3Status
  Q3RawData_Write(const unsigned char *data, unsigned long size,
                  TQ3FileObject theFile);
 
  /*******************************************************************************
   **                                                                          **
   **                     Convenient Primitives Routines                       **
   **                                                                          **
   *****************************************************************************/
  TQ3Status
  Q3Point2D_Read(TQ3Point2D *point2D, TQ3FileObject theFile);
 
  TQ3Status
  Q3Point2D_Write(const TQ3Point2D *point2D, TQ3FileObject theFile);
 
  TQ3Status
  Q3Point3D_Read(TQ3Point3D *point3D, TQ3FileObject theFile);
 
  TQ3Status
  Q3Point3D_Write(const TQ3Point3D *point3D, TQ3FileObject theFile);
 
  TQ3Status
  Q3RationalPoint3D_Read(TQ3RationalPoint3D *point3D, TQ3FileObject theFile);
 
  TQ3Status
  Q3RationalPoint3D_Write(const TQ3RationalPoint3D *point3D,
                          TQ3FileObject theFile);
 
  TQ3Status
  Q3RationalPoint4D_Read(TQ3RationalPoint4D *point4D, TQ3FileObject theFile);
 
  TQ3Status
  Q3RationalPoint4D_Write(const TQ3RationalPoint4D *point4D,
                          TQ3FileObject theFile);
 
  TQ3Status
  Q3Vector2D_Read(TQ3Vector2D *vector2D, TQ3FileObject theFile);
 
  TQ3Status
  Q3Vector2D_Write(const TQ3Vector2D *vector2D, TQ3FileObject theFile);
 
  TQ3Status
  Q3Vector3D_Read(TQ3Vector3D *vector3D, TQ3FileObject theFile);
 
  TQ3Status
  Q3Vector3D_Write(const TQ3Vector3D *vector3D, TQ3FileObject theFile);
 
  TQ3Status
  Q3Matrix4x4_Read(TQ3Matrix4x4 *matrix4x4, TQ3FileObject theFile);
 
  TQ3Status
  Q3Matrix4x4_Write(const TQ3Matrix4x4 *matrix4x4, TQ3FileObject theFile);
 
  TQ3Status
  Q3Tangent2D_Read(TQ3Tangent2D *tangent2D, TQ3FileObject theFile);
 
  TQ3Status
  Q3Tangent2D_Write(const TQ3Tangent2D *tangent2D, TQ3FileObject theFile);
 
  TQ3Status
  Q3Tangent3D_Read(TQ3Tangent3D *tangent3D, TQ3FileObject theFile);
 
  TQ3Status
  Q3Tangent3D_Write(const TQ3Tangent3D *tangent3D, TQ3FileObject theFile);
 
  TQ3Status
  Q3Comment_Write(char *comment, TQ3FileObject theFile);
 
  /*******************************************************************************
   **                                                                          **
   **                             Unknown Object                               **
   **                                                                          **
   **     Unknown objects are generated when reading files which contain       **
   **     custom data which has not been registered in the current             **
   **     instantiation of QuickDraw 3D.                                       **
   **                                                                          **
   *****************************************************************************/
  TQ3ObjectType
  Q3Unknown_GetType(TQ3UnknownObject unknownObject);
 
  TQ3Status
  Q3Unknown_GetDirtyState(TQ3UnknownObject unknownObject, TQ3Boolean *isDirty);
 
  TQ3Status
  Q3Unknown_SetDirtyState(TQ3UnknownObject unknownObject, TQ3Boolean isDirty);
 
/*******************************************************************************
 **                                                                          **
 **                         Unknown Text Routines                            **
 **                                                                          **
 *****************************************************************************/
#endif 
  struct TQ3UnknownTextData
  {
    char *objectName; 
    char *contents;   
  };
  typedef struct TQ3UnknownTextData TQ3UnknownTextData;
#if CALL_NOT_IN_CARBON
  TQ3Status
  Q3UnknownText_GetData(TQ3UnknownObject unknownObject,
                        TQ3UnknownTextData *unknownTextData);
 
  TQ3Status
  Q3UnknownText_EmptyData(TQ3UnknownTextData *unknownTextData);
 
/*******************************************************************************
 **                                                                          **
 **                         Unknown Binary Routines                          **
 **                                                                          **
 *****************************************************************************/
#endif 
  struct TQ3UnknownBinaryData
  {
    TQ3ObjectType objectType;
    unsigned long size;
    TQ3Endian byteOrder;
    char *contents;
  };
  typedef struct TQ3UnknownBinaryData TQ3UnknownBinaryData;
#if CALL_NOT_IN_CARBON
  TQ3Status
  Q3UnknownBinary_GetData(TQ3UnknownObject unknownObject,
                          TQ3UnknownBinaryData *unknownBinaryData);
 
  TQ3Status
  Q3UnknownBinary_EmptyData(TQ3UnknownBinaryData *unknownBinaryData);
 
#endif 
#if CALL_NOT_IN_CARBON
  TQ3Status
  Q3UnknownBinary_GetTypeString(TQ3UnknownObject unknownObject,
                                char **typeString);
 
  TQ3Status
  Q3UnknownBinary_EmptyTypeString(char **typeString);
 
#endif 
/*******************************************************************************
 **                                                                          **
 **                         ViewHints routines                               **
 **                                                                          **
 **     ViewHints are an object in a metafile to give you some hints on how  **
 **     to render a scene.  You may create a view with any of the objects    **
 **     retrieved from it, or you can just throw it away.                    **
 **                                                                          **
 **     To write a view hints to a file, create a view hints object from a   **
 **     view and write the view hints.                                       **
 **                                                                          **
 *****************************************************************************/
#if CALL_NOT_IN_CARBON
  TQ3ViewHintsObject
  Q3ViewHints_New(TQ3ViewObject view);
 
  TQ3Status
  Q3ViewHints_SetRenderer(TQ3ViewHintsObject viewHints,
                          TQ3RendererObject renderer);
 
  TQ3Status
  Q3ViewHints_GetRenderer(TQ3ViewHintsObject viewHints,
                          TQ3RendererObject *renderer);
 
  TQ3Status
  Q3ViewHints_SetCamera(TQ3ViewHintsObject viewHints, TQ3CameraObject camera);
 
  TQ3Status
  Q3ViewHints_GetCamera(TQ3ViewHintsObject viewHints, TQ3CameraObject *camera);
 
  TQ3Status
  Q3ViewHints_SetLightGroup(TQ3ViewHintsObject viewHints,
                            TQ3GroupObject lightGroup);
 
  TQ3Status
  Q3ViewHints_GetLightGroup(TQ3ViewHintsObject viewHints,
                            TQ3GroupObject *lightGroup);
 
  TQ3Status
  Q3ViewHints_SetAttributeSet(TQ3ViewHintsObject viewHints,
                              TQ3AttributeSet attributeSet);
 
  TQ3Status
  Q3ViewHints_GetAttributeSet(TQ3ViewHintsObject viewHints,
                              TQ3AttributeSet *attributeSet);
 
  TQ3Status
  Q3ViewHints_SetDimensionsState(TQ3ViewHintsObject viewHints,
                                 TQ3Boolean isValid);
 
  TQ3Status
  Q3ViewHints_GetDimensionsState(TQ3ViewHintsObject viewHints,
                                 TQ3Boolean *isValid);
 
  TQ3Status
  Q3ViewHints_SetDimensions(TQ3ViewHintsObject viewHints, unsigned long width,
                            unsigned long height);
 
  TQ3Status
  Q3ViewHints_GetDimensions(TQ3ViewHintsObject viewHints, unsigned long *width,
                            unsigned long *height);
 
  TQ3Status
  Q3ViewHints_SetMaskState(TQ3ViewHintsObject viewHints, TQ3Boolean isValid);
 
  TQ3Status
  Q3ViewHints_GetMaskState(TQ3ViewHintsObject viewHints, TQ3Boolean *isValid);
 
  TQ3Status
  Q3ViewHints_SetMask(TQ3ViewHintsObject viewHints, const TQ3Bitmap *mask);
 
  TQ3Status
  Q3ViewHints_GetMask(TQ3ViewHintsObject viewHints, TQ3Bitmap *mask);
 
  TQ3Status
  Q3ViewHints_SetClearImageMethod(TQ3ViewHintsObject viewHints,
                                  TQ3DrawContextClearImageMethod clearMethod);
 
  TQ3Status
  Q3ViewHints_GetClearImageMethod(TQ3ViewHintsObject viewHints,
                                  TQ3DrawContextClearImageMethod *clearMethod);
 
  TQ3Status
  Q3ViewHints_SetClearImageColor(TQ3ViewHintsObject viewHints,
                                 const TQ3ColorARGB *color);
 
  TQ3Status
  Q3ViewHints_GetClearImageColor(TQ3ViewHintsObject viewHints,
                                 TQ3ColorARGB *color);
 
#endif 
#if PRAGMA_ENUM_ALWAYSINT
#pragma enumsalwaysint reset
#ifdef __QD3DIO__RESTORE_TWOBYTEINTS
#pragma fourbyteints off
#endif
#elif PRAGMA_ENUM_OPTIONS
#pragma option enum =reset
#elif defined(__QD3DIO__RESTORE_PACKED_ENUMS)
#pragma options(pack_enums)
#endif
 
#if PRAGMA_STRUCT_ALIGN
#pragma options align = reset
#elif PRAGMA_STRUCT_PACKPUSH
#pragma pack(pop)
#elif PRAGMA_STRUCT_PACK
#pragma pack()
#endif
 
#ifdef PRAGMA_IMPORT_OFF
#pragma import off
#elif PRAGMA_IMPORT
#pragma import reset
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif