/*! @header QuesaErrors.h
Declares the Quesa error manager.
*/
/* NAME:
QuesaErrors.h
DESCRIPTION:
Quesa public header.
COPYRIGHT:
Copyright (c) 1999-2004, Quesa Developers. All rights reserved.
For the current release of Quesa, please see:
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
o Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
o Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials provided
with the distribution.
o Neither the name of Quesa nor the names of its contributors
may be used to endorse or promote products derived from this
software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
___________________________________________________________________________
*/
#ifndef QUESA_ERRORS_HDR
#define QUESA_ERRORS_HDR
//=============================================================================
// Include files
//-----------------------------------------------------------------------------
#include "Quesa.h"
// Disable QD3D header
#if defined(__QD3DERRORS__)
#error
#endif
#define __QD3DERRORS__
//=============================================================================
// C++ preamble
//-----------------------------------------------------------------------------
#ifdef __cplusplus
extern "C" {
#endif
//=============================================================================
// Constants
//-----------------------------------------------------------------------------
/*!
* @enum
* TQ3Error
* @discussion
* Quesa error constants.
*
* @constant kQ3ErrorNone No error.
* @constant kQ3ErrorInternalError Internal error.
* @constant kQ3ErrorNoRecovery No recovery.
* @constant kQ3ErrorLastFatalError Last fatal error.
* @constant kQ3ErrorNotInitialized Not initialized.
* @constant kQ3ErrorAlreadyInitialized Already initialized.
* @constant kQ3ErrorUnimplemented Unimplemented.
* @constant kQ3ErrorRegistrationFailed Registration failed.
* @constant kQ3ErrorUnixError Unix error.
* @constant kQ3ErrorMacintoshError Macintosh error.
* @constant kQ3ErrorX11Error X11 error.
* @constant kQ3ErrorMemoryLeak Memory leak.
* @constant kQ3ErrorOutOfMemory Out of memory.
* @constant kQ3ErrorNULLParameter NULL parameter.
* @constant kQ3ErrorParameterOutOfRange Parameter out of range.
* @constant kQ3ErrorInvalidParameter Invalid parameter.
* @constant kQ3ErrorInvalidData Invalid data.
* @constant kQ3ErrorAcceleratorAlreadySet Accelerator already set.
* @constant kQ3ErrorVector3DNotUnitLength Vector3D not unit length.
* @constant kQ3ErrorVector3DZeroLength Vector3D zero length.
* @constant kQ3ErrorInvalidObject Invalid object.
* @constant kQ3ErrorInvalidObjectClass Invalid object class.
* @constant kQ3ErrorInvalidObjectType Invalid object type.
* @constant kQ3ErrorInvalidObjectName Invalid object name.
* @constant kQ3ErrorObjectClassInUse Object class in use.
* @constant kQ3ErrorAccessRestricted Access restricted.
* @constant kQ3ErrorMetaHandlerRequired Meta handler required.
* @constant kQ3ErrorNeedRequiredMethods Need required methods.
* @constant kQ3ErrorNoSubClassType No sub class type.
* @constant kQ3ErrorUnknownElementType Unknown element type.
* @constant kQ3ErrorNotSupported Not supported.
* @constant kQ3ErrorNoExtensionsFolder No extensions folder.
* @constant kQ3ErrorExtensionError Extension error.
* @constant kQ3ErrorPrivateExtensionError Private extension error.
* @constant kQ3ErrorDegenerateGeometry Degenerate geometry detected.
* @constant kQ3ErrorGeometryInsufficientNumberOfPoints Geometry has an insufficient number of points.
* @constant kQ3ErrorNoStorageSetForFile No storage set for file.
* @constant kQ3ErrorEndOfFile End of file.
* @constant kQ3ErrorFileCancelled File cancelled.
* @constant kQ3ErrorInvalidMetafile Invalid metafile.
* @constant kQ3ErrorInvalidMetafilePrimitive Invalid metafile primitive.
* @constant kQ3ErrorInvalidMetafileLabel Invalid metafile label.
* @constant kQ3ErrorInvalidMetafileObject Invalid metafile object.
* @constant kQ3ErrorInvalidMetafileSubObject Invalid metafile sub object.
* @constant kQ3ErrorInvalidSubObjectForObject Invalid sub object for object.
* @constant kQ3ErrorUnresolvableReference Unresolvable reference.
* @constant kQ3ErrorUnknownObject Unknown object.
* @constant kQ3ErrorStorageInUse Storage in use.
* @constant kQ3ErrorStorageAlreadyOpen Storage already open.
* @constant kQ3ErrorStorageNotOpen Storage not open.
* @constant kQ3ErrorStorageIsOpen Storage is open.
* @constant kQ3ErrorFileAlreadyOpen File already open.
* @constant kQ3ErrorFileNotOpen File not open.
* @constant kQ3ErrorFileIsOpen File is open.
* @constant kQ3ErrorBeginWriteAlreadyCalled Begin write already called.
* @constant kQ3ErrorBeginWriteNotCalled Begin write not called.
* @constant kQ3ErrorEndWriteNotCalled End write not called.
* @constant kQ3ErrorReadStateInactive Read state inactive.
* @constant kQ3ErrorStateUnavailable State unavailable.
* @constant kQ3ErrorWriteStateInactive Write state inactive.
* @constant kQ3ErrorSizeNotLongAligned Size not long aligned.
* @constant kQ3ErrorFileModeRestriction File mode restriction.
* @constant kQ3ErrorInvalidHexString Invalid hex string.
* @constant kQ3ErrorWroteMoreThanSize Wrote more than size.
* @constant kQ3ErrorWroteLessThanSize Wrote less than size.
* @constant kQ3ErrorReadLessThanSize Read less than size.
* @constant kQ3ErrorReadMoreThanSize Read more than size.
* @constant kQ3ErrorNoBeginGroup No begin group.
* @constant kQ3ErrorSizeMismatch Size mismatch.
* @constant kQ3ErrorStringExceedsMaximumLength String exceeds maximum length.
* @constant kQ3ErrorValueExceedsMaximumSize Value exceeds maximum size.
* @constant kQ3ErrorNonUniqueLabel Non unique label.
* @constant kQ3ErrorEndOfContainer End of container.
* @constant kQ3ErrorUnmatchedEndGroup Unmatched end group.
* @constant kQ3ErrorFileVersionExists File version exists.
* @constant kQ3ErrorViewNotStarted View not started.
* @constant kQ3ErrorViewIsStarted View is started.
* @constant kQ3ErrorRendererNotSet Renderer not set.
* @constant kQ3ErrorRenderingIsActive Rendering is active.
* @constant kQ3ErrorImmediateModeUnderflow Immediate mode underflow.
* @constant kQ3ErrorDisplayNotSet Display not set.
* @constant kQ3ErrorCameraNotSet Camera not set.
* @constant kQ3ErrorDrawContextNotSet Draw context not set.
* @constant kQ3ErrorNonInvertibleMatrix Non invertible matrix.
* @constant kQ3ErrorRenderingNotStarted Rendering not started.
* @constant kQ3ErrorPickingNotStarted Picking not started.
* @constant kQ3ErrorBoundsNotStarted Bounds not started.
* @constant kQ3ErrorDataNotAvailable Data not available.
* @constant kQ3ErrorNothingToPop Nothing to pop.
* @constant kQ3ErrorUnknownStudioType Unknown studio type.
* @constant kQ3ErrorAlreadyRendering Already rendering.
* @constant kQ3ErrorStartGroupRange Start group range.
* @constant kQ3ErrorUnsupportedGeometryType Unsupported geometry type.
* @constant kQ3ErrorInvalidGeometryType Invalid geometry type.
* @constant kQ3ErrorUnsupportedFunctionality Unsupported functionality.
* @constant kQ3ErrorInvalidPositionForGroup Invalid position for group.
* @constant kQ3ErrorInvalidObjectForGroup Invalid object for group.
* @constant kQ3ErrorInvalidObjectForPosition Invalid object for position.
* @constant kQ3ErrorScaleOfZero Scale of zero.
* @constant kQ3ErrorBadStringType Bad string type.
* @constant kQ3ErrorAttributeNotContained Attribute not contained.
* @constant kQ3ErrorAttributeInvalidType Attribute invalid type.
* @constant kQ3ErrorInvalidCameraValues Invalid camera values.
* @constant kQ3ErrorBadDrawContextType Bad draw context type.
* @constant kQ3ErrorBadDrawContextFlag Bad draw context flag.
* @constant kQ3ErrorBadDrawContext Bad draw context.
* @constant kQ3ErrorUnsupportedPixelDepth Unsupported pixel depth.
* @constant kQ3ErrorController Controller error.
* @constant kQ3ErrorTracker Tracker error.
* @constant kQ3ErrorWin32Error Windows error.
* @constant kQ3ErrorTypeAlreadyExistsAndHasSubclasses Type already exists and has subclasses.
* @constant kQ3ErrorTypeAlreadyExistsAndOtherClassesDependOnIt Type already exists and other classes depend on it.
* @constant kQ3ErrorTypeAlreadyExistsAndHasObjectInstances Type already exists and has object instances.
* @constant kQ3ErrorPickingLoopFailed Picking loop failed.
* @constant kQ3ErrorRenderingLoopFailed Rendering loop failed.
* @constant kQ3ErrorWritingLoopFailed Writing loop failed.
* @constant kQ3ErrorBoundingLoopFailed Bounding loop failed.
* @constant kQ3ErrorPlatformError Platform-specific error. Not available in QD3D.
* @constant kQ3ErrorInfiniteRationalPoint Infinite rational point. Not available in QD3D.
*/
typedef enum {
kQ3ErrorNone = 0,
kQ3ErrorFirst = -28500,
kQ3ErrorInternalError = -28500,
kQ3ErrorNoRecovery = -28499,
kQ3ErrorLastFatalError = -28498,
kQ3ErrorNotUsedByQD3D_1 = -28497,
kQ3ErrorNotUsedByQD3D_2 = -28496,
kQ3ErrorNotUsedByQD3D_3 = -28495,
kQ3ErrorNotUsedByQD3D_4 = -28494,
kQ3ErrorNotUsedByQD3D_5 = -28493,
kQ3ErrorNotUsedByQD3D_6 = -28492,
kQ3ErrorNotUsedByQD3D_7 = -28491,
kQ3ErrorNotInitialized = -28490,
kQ3ErrorAlreadyInitialized = -28489,
kQ3ErrorUnimplemented = -28488,
kQ3ErrorRegistrationFailed = -28487,
kQ3ErrorUnixError = -28486,
kQ3ErrorMacintoshError = -28485,
kQ3ErrorX11Error = -28484,
kQ3ErrorMemoryLeak = -28483,
kQ3ErrorOutOfMemory = -28482,
kQ3ErrorNULLParameter = -28481,
kQ3ErrorParameterOutOfRange = -28480,
kQ3ErrorInvalidParameter = -28479,
kQ3ErrorInvalidData = -28478,
kQ3ErrorAcceleratorAlreadySet = -28477,
kQ3ErrorVector3DNotUnitLength = -28476,
kQ3ErrorVector3DZeroLength = -28475,
kQ3ErrorInvalidObject = -28474,
kQ3ErrorInvalidObjectClass = -28473,
kQ3ErrorInvalidObjectType = -28472,
kQ3ErrorInvalidObjectName = -28471,
kQ3ErrorObjectClassInUse = -28470,
kQ3ErrorAccessRestricted = -28469,
kQ3ErrorMetaHandlerRequired = -28468,
kQ3ErrorNeedRequiredMethods = -28467,
kQ3ErrorNoSubClassType = -28466,
kQ3ErrorUnknownElementType = -28465,
kQ3ErrorNotSupported = -28464,
kQ3ErrorNoExtensionsFolder = -28463,
kQ3ErrorExtensionError = -28462,
kQ3ErrorPrivateExtensionError = -28461,
kQ3ErrorDegenerateGeometry = -28460,
kQ3ErrorGeometryInsufficientNumberOfPoints = -28459,
kQ3ErrorNoStorageSetForFile = -28458,
kQ3ErrorEndOfFile = -28457,
kQ3ErrorFileCancelled = -28456,
kQ3ErrorInvalidMetafile = -28455,
kQ3ErrorInvalidMetafilePrimitive = -28454,
kQ3ErrorInvalidMetafileLabel = -28453,
kQ3ErrorInvalidMetafileObject = -28452,
kQ3ErrorInvalidMetafileSubObject = -28451,
kQ3ErrorInvalidSubObjectForObject = -28450,
kQ3ErrorUnresolvableReference = -28449,
kQ3ErrorUnknownObject = -28448,
kQ3ErrorStorageInUse = -28447,
kQ3ErrorStorageAlreadyOpen = -28446,
kQ3ErrorStorageNotOpen = -28445,
kQ3ErrorStorageIsOpen = -28444,
kQ3ErrorFileAlreadyOpen = -28443,
kQ3ErrorFileNotOpen = -28442,
kQ3ErrorFileIsOpen = -28441,
kQ3ErrorBeginWriteAlreadyCalled = -28440,
kQ3ErrorBeginWriteNotCalled = -28439,
kQ3ErrorEndWriteNotCalled = -28438,
kQ3ErrorReadStateInactive = -28437,
kQ3ErrorStateUnavailable = -28436,
kQ3ErrorWriteStateInactive = -28435,
kQ3ErrorSizeNotLongAligned = -28434,
kQ3ErrorFileModeRestriction = -28433,
kQ3ErrorInvalidHexString = -28432,
kQ3ErrorWroteMoreThanSize = -28431,
kQ3ErrorWroteLessThanSize = -28430,
kQ3ErrorReadLessThanSize = -28429,
kQ3ErrorReadMoreThanSize = -28428,
kQ3ErrorNoBeginGroup = -28427,
kQ3ErrorSizeMismatch = -28426,
kQ3ErrorStringExceedsMaximumLength = -28425,
kQ3ErrorValueExceedsMaximumSize = -28424,
kQ3ErrorNonUniqueLabel = -28423,
kQ3ErrorEndOfContainer = -28422,
kQ3ErrorUnmatchedEndGroup = -28421,
kQ3ErrorFileVersionExists = -28420,
kQ3ErrorViewNotStarted = -28419,
kQ3ErrorViewIsStarted = -28418,
kQ3ErrorRendererNotSet = -28417,
kQ3ErrorRenderingIsActive = -28416,
kQ3ErrorImmediateModeUnderflow = -28415,
kQ3ErrorDisplayNotSet = -28414,
kQ3ErrorCameraNotSet = -28413,
kQ3ErrorDrawContextNotSet = -28412,
kQ3ErrorNonInvertibleMatrix = -28411,
kQ3ErrorRenderingNotStarted = -28410,
kQ3ErrorPickingNotStarted = -28409,
kQ3ErrorBoundsNotStarted = -28408,
kQ3ErrorDataNotAvailable = -28407,
kQ3ErrorNothingToPop = -28406,
kQ3ErrorUnknownStudioType = -28405,
kQ3ErrorAlreadyRendering = -28404,
kQ3ErrorStartGroupRange = -28403,
kQ3ErrorUnsupportedGeometryType = -28402,
kQ3ErrorInvalidGeometryType = -28401,
kQ3ErrorUnsupportedFunctionality = -28400,
kQ3ErrorInvalidPositionForGroup = -28399,
kQ3ErrorInvalidObjectForGroup = -28398,
kQ3ErrorInvalidObjectForPosition = -28397,
kQ3ErrorScaleOfZero = -28396,
kQ3ErrorBadStringType = -28395,
kQ3ErrorAttributeNotContained = -28394,
kQ3ErrorAttributeInvalidType = -28393,
kQ3ErrorInvalidCameraValues = -28392,
kQ3ErrorBadDrawContextType = -28391,
kQ3ErrorBadDrawContextFlag = -28390,
kQ3ErrorBadDrawContext = -28389,
kQ3ErrorUnsupportedPixelDepth = -28388,
kQ3ErrorController = -28387,
kQ3ErrorTracker = -28386,
kQ3ErrorWin32Error = -28385,
kQ3ErrorTypeAlreadyExistsAndHasSubclasses = -28384,
kQ3ErrorTypeAlreadyExistsAndOtherClassesDependOnIt = -28383,
kQ3ErrorTypeAlreadyExistsAndHasObjectInstances = -28382,
kQ3ErrorPickingLoopFailed = -28381,
kQ3ErrorRenderingLoopFailed = -28380,
kQ3ErrorWritingLoopFailed = -28379,
kQ3ErrorBoundingLoopFailed = -28378,
#if QUESA_ALLOW_QD3D_EXTENSIONS
kQ3ErrorPlatformError = -28377,
kQ3ErrorInfiniteRationalPoint = -28376,
#endif // QUESA_ALLOW_QD3D_EXTENSIONS
kQ3ErrorLast,
kQ3ErrorSize32 = 0xFFFFFFFF
} TQ3Error;
/*!
* @enum
* TQ3Warning
* @discussion
* Quesa warning constants.
*
* @constant kQ3WarningNone No warning.
* @constant kQ3WarningInternalException Internal exception.
* @constant kQ3WarningNoObjectSupportForDuplicateMethod No object support for duplicate method.
* @constant kQ3WarningNoObjectSupportForDrawMethod No object support for draw method.
* @constant kQ3WarningNoObjectSupportForWriteMethod No object support for write method.
* @constant kQ3WarningNoObjectSupportForReadMethod No object support for read method.
* @constant kQ3WarningUnknownElementType Unknown element type.
* @constant kQ3WarningTypeAndMethodAlreadyDefined Type and method already defined.
* @constant kQ3WarningTypeIsOutOfRange Type is out of range.
* @constant kQ3WarningTypeHasNotBeenRegistered Type has not been registered.
* @constant kQ3WarningVector3DNotUnitLength Vector3D not unit length.
* @constant kQ3WarningInvalidSubObjectForObject Invalid sub object for object.
* @constant kQ3WarningInvalidHexString Invalid hex string.
* @constant kQ3WarningUnknownObject Unknown object.
* @constant kQ3WarningInvalidMetafileObject Invalid metafile object.
* @constant kQ3WarningUnmatchedBeginGroup Unmatched begin group.
* @constant kQ3WarningUnmatchedEndGroup Unmatched end group.
* @constant kQ3WarningInvalidTableOfContents Invalid table of contents.
* @constant kQ3WarningUnresolvableReference Unresolvable reference.
* @constant kQ3WarningNoAttachMethod No attach method.
* @constant kQ3WarningInconsistentData Inconsistent data.
* @constant kQ3WarningReadLessThanSize Read less than size.
* @constant kQ3WarningFilePointerResolutionFailed File pointer resolution failed.
* @constant kQ3WarningFilePointerRedefined File pointer redefined.
* @constant kQ3WarningStringExceedsMaximumLength String exceeds maximum length.
* @constant kQ3WarningLowMemory Low memory.
* @constant kQ3WarningPossibleMemoryLeak Possible memory leak.
* @constant kQ3WarningViewTraversalInProgress View traversal in progress.
* @constant kQ3WarningNonInvertibleMatrix Non invertible matrix.
* @constant kQ3WarningQuaternionEntriesAreZero Quaternion entries are zero.
* @constant kQ3WarningFunctionalityNotSupported Functionality not supported.
* @constant kQ3WarningInvalidPaneDimensions Invalid pane dimensions.
* @constant kQ3WarningPickParamOutside Pick param outside.
* @constant kQ3WarningScaleEntriesAllZero Scale entries all zero.
* @constant kQ3WarningScaleContainsNegativeEntries Scale contains negative entries.
* @constant kQ3WarningParameterOutOfRange Parameter out of range.
* @constant kQ3WarningExtensionNotLoading Extension not loading.
* @constant kQ3WarningTypeAlreadyRegistered Type already registered.
* @constant kQ3WarningTypeSameVersionAlreadyRegistered Type same version already registered.
* @constant kQ3WarningTypeNewerVersionAlreadyRegistered Type newer version already registered.
* @constant kQ3WarningInvalidObjectInGroupMetafile Invalid object in group metafile.
* @constant kQ3WarningQuaternionNotNormalized Quaternion is not normalized. Not available in QD3D.
* @constant kQ3WarningNormalCanNotBeFlipped Normal can not be flipped as they would under QD3D. Not available in QD3D.
* @constant kQ3WarningTriangleNotNormalized Triangle normal is not normalized. Not available in QD3D.
* @constant kQ3WarningVertexNotNormalized Vertex normal is not normalized. Not available in QD3D.
* @constant kQ3WarningReadInfiniteFloatingPointNumber Floating-point number read from file was
* infinite or NaN. Not available in QD3D.
* @constant kQ3WarningReadBadNormalVector A supposed normal vector has components so
* large or small that it cannot be normalized.
* Not available in QD3D.
*/
typedef enum {
kQ3WarningNone = 0,
kQ3WarningFirst = -28300,
kQ3WarningInternalException = -28300,
kQ3WarningNoObjectSupportForDuplicateMethod = -28299,
kQ3WarningNoObjectSupportForDrawMethod = -28298,
kQ3WarningNoObjectSupportForWriteMethod = -28297,
kQ3WarningNoObjectSupportForReadMethod = -28296,
kQ3WarningUnknownElementType = -28295,
kQ3WarningTypeAndMethodAlreadyDefined = -28294,
kQ3WarningTypeIsOutOfRange = -28293,
kQ3WarningTypeHasNotBeenRegistered = -28292,
kQ3WarningVector3DNotUnitLength = -28291,
kQ3WarningInvalidSubObjectForObject = -28290,
kQ3WarningInvalidHexString = -28289,
kQ3WarningUnknownObject = -28288,
kQ3WarningInvalidMetafileObject = -28287,
kQ3WarningUnmatchedBeginGroup = -28286,
kQ3WarningUnmatchedEndGroup = -28285,
kQ3WarningInvalidTableOfContents = -28284,
kQ3WarningUnresolvableReference = -28283,
kQ3WarningNoAttachMethod = -28282,
kQ3WarningInconsistentData = -28281,
kQ3WarningReadLessThanSize = -28280,
kQ3WarningFilePointerResolutionFailed = -28279,
kQ3WarningFilePointerRedefined = -28278,
kQ3WarningStringExceedsMaximumLength = -28277,
kQ3WarningLowMemory = -28276,
kQ3WarningPossibleMemoryLeak = -28275,
kQ3WarningViewTraversalInProgress = -28274,
kQ3WarningNonInvertibleMatrix = -28273,
kQ3WarningQuaternionEntriesAreZero = -28272,
kQ3WarningFunctionalityNotSupported = -28271,
kQ3WarningInvalidPaneDimensions = -28270,
kQ3WarningPickParamOutside = -28269,
kQ3WarningScaleEntriesAllZero = -28268,
kQ3WarningScaleContainsNegativeEntries = -28267,
kQ3WarningParameterOutOfRange = -28266,
kQ3WarningExtensionNotLoading = -28265,
kQ3WarningTypeAlreadyRegistered = -28264,
kQ3WarningTypeSameVersionAlreadyRegistered = -28263,
kQ3WarningTypeNewerVersionAlreadyRegistered = -28262,
kQ3WarningInvalidObjectInGroupMetafile = -28261,
#if QUESA_ALLOW_QD3D_EXTENSIONS
kQ3WarningQuaternionNotNormalized = -28260,
kQ3WarningNormalCanNotBeFlipped = -28259,
kQ3WarningTriangleNotNormalized = -28258,
kQ3WarningVertexNotNormalized = -28257,
kQ3WarningReadInfiniteFloatingPointNumber = -28256,
kQ3WarningReadBadNormalVector = -28255,
#endif // QUESA_ALLOW_QD3D_EXTENSIONS
kQ3WarningLast,
kQ3WarningSize32 = 0xFFFFFFFF
} TQ3Warning;
/*!
* @enum
* TQ3Notice
* @discussion
* Quesa notice constants.
*
* @constant kQ3NoticeNone No notice.
* @constant kQ3NoticeDataAlreadyEmpty Data already empty.
* @constant kQ3NoticeMethodNotSupported Method not supported.
* @constant kQ3NoticeObjectAlreadySet Object already set.
* @constant kQ3NoticeParameterOutOfRange Parameter out of range.
* @constant kQ3NoticeFileAliasWasChanged File alias was changed.
* @constant kQ3NoticeMeshVertexHasNoComponent Mesh vertex has no component.
* @constant kQ3NoticeMeshInvalidVertexFacePair Mesh invalid vertex face pair.
* @constant kQ3NoticeMeshEdgeVertexDoNotCorrespond Mesh edge vertex do not correspond.
* @constant kQ3NoticeMeshEdgeIsNotBoundary Mesh edge is not boundary.
* @constant kQ3NoticeDrawContextNotSetUsingInternalDefaults Draw context not set using internal defaults.
* @constant kQ3NoticeInvalidAttenuationTypeUsingInternalDefaults Invalid attenuation type using internal defaults.
* @constant kQ3NoticeBrightnessGreaterThanOne Brightness greater than 1.0.
* @constant kQ3NoticeScaleContainsZeroEntries Scale contains zero entries.
* @constant kQ3NoticeSystemAlreadyInitialized System already initialized.
* @constant kQ3NoticeViewSyncCalledAgain View sync called again.
* @constant kQ3NoticeFileCancelled File cancelled.
* @constant kQ3NoticeBrightnessLessThanZero Brightness less than 0.0. Not available in QD3D.
*/
typedef enum {
kQ3NoticeNone = 0,
kQ3NoticeFirst = -28100,
kQ3NoticeDataAlreadyEmpty = -28100,
kQ3NoticeMethodNotSupported = -28099,
kQ3NoticeObjectAlreadySet = -28098,
kQ3NoticeParameterOutOfRange = -28097,
kQ3NoticeFileAliasWasChanged = -28096,
kQ3NoticeMeshVertexHasNoComponent = -28095,
kQ3NoticeMeshInvalidVertexFacePair = -28094,
kQ3NoticeMeshEdgeVertexDoNotCorrespond = -28093,
kQ3NoticeMeshEdgeIsNotBoundary = -28092,
kQ3NoticeDrawContextNotSetUsingInternalDefaults = -28091,
kQ3NoticeInvalidAttenuationTypeUsingInternalDefaults = -28090,
kQ3NoticeBrightnessGreaterThanOne = -28089,
kQ3NoticeScaleContainsZeroEntries = -28088,
kQ3NoticeSystemAlreadyInitialized = -28087,
kQ3NoticeViewSyncCalledAgain = -28086,
kQ3NoticeFileCancelled = -28085,
#if QUESA_ALLOW_QD3D_EXTENSIONS
kQ3NoticeBrightnessLessThanZero = -28084,
#endif // QUESA_ALLOW_QD3D_EXTENSIONS
kQ3NoticeLast,
kQ3NoticeSize32 = 0xFFFFFFFF
} TQ3Notice;
//=============================================================================
// Types
//-----------------------------------------------------------------------------
/*!
* @typedef
* TQ3ErrorMethod
* @discussion
* Error Manager error callback.
*
* @param firstError The first error which has occurred since the last
* time the handler was invoked.
* @param lastError The most recent error which has occurred.
* @param userData The reference parameter passed to Q3Error_Register.
*/
typedef Q3_CALLBACK_API_C(void, TQ3ErrorMethod)(
TQ3Error firstError,
TQ3Error lastError,
TQ3Int32 userData);
/*!
* @typedef
* TQ3WarningMethod
* @discussion
* Error Manager warning callback.
*
* @param firstWarning The first warning which has occurred since the last
* time the handler was invoked.
* @param lastWarning The most recent warning which has occurred.
* @param userData The reference parameter passed to Q3Warning_Register.
*/
typedef Q3_CALLBACK_API_C(void, TQ3WarningMethod)(
TQ3Warning firstWarning,
TQ3Warning lastWarning,
TQ3Int32 userData);
/*!
* @typedef
* TQ3NoticeMethod
* @discussion
* Error Manager notice callback.
*
* @param firstNotice The first notice which has occurred since the last
* time the handler was invoked.
* @param lastNotice The most recent notice which has occurred.
* @param userData The reference parameter passed to Q3Notice_Register.
*/
typedef Q3_CALLBACK_API_C(void, TQ3NoticeMethod)(
TQ3Notice firstNotice,
TQ3Notice lastNotice,
TQ3Int32 userData);
//=============================================================================
// Function prototypes
//-----------------------------------------------------------------------------
/*!
* @function
* Q3Error_Register
* @discussion
* Install a callback to handle errors.
*
* Use this function to register an error-handling function that will be
* called when Quesa detects an error condition that it can't handle.
* Your callback should not call Quesa except for Error Manager routines.
*
* @param errorPost Callback to receive error notifications.
* @param reference Constant passed to error callback.
* @result kQ3Success when the callback is installed.
*/
Q3_EXTERN_API_C ( TQ3Status )
Q3Error_Register (
TQ3ErrorMethod errorPost,
TQ3Int32 reference
);
/*!
* @function
* Q3Warning_Register
* @discussion
* Install a callback to handle warnings.
*
* Use this function to register an warning-handling function that will be
* called when a Quesa routine generates a warning that it can't handle.
* Your callback should not call Quesa except for Error Manager routines.
*
* @param warningPost Callback to receive warning notifications.
* @param reference Constant passed to warning callback.
* @result kQ3Success when the callback is installed.
*/
Q3_EXTERN_API_C ( TQ3Status )
Q3Warning_Register (
TQ3WarningMethod warningPost,
TQ3Int32 reference
);
/*!
* @function
* Q3Notice_Register
* @discussion
* Install a callback to handle notifications.
*
* Use this function to register an warning-handling function that will be
* called when a Quesa routine generates a notice.
* This will only happen in debugging versions of Quesa.
* Your callback should not call Quesa except for Error Manager routines.
*
* @param noticePost Routine to be called to handle notices.
* @param reference Constant passed to notice callback.
* @result kQ3Success when the callback is installed.
*/
Q3_EXTERN_API_C ( TQ3Status )
Q3Notice_Register (
TQ3NoticeMethod noticePost,
TQ3Int32 reference
);
/*!
* @function
* Q3Error_Get
* @discussion
* Retrieve latest error codes from Quesa.
*
* Retrieve the most recent error code, and optionally also the oldest
* unreported error code. After this call, the next Quesa call that is not
* part of the Error Manager will clear the error codes.
*
* @param firstError Pointer to variable to receive the oldest error code
* that has not yet been reported. May be NULL if you
* don't need that information.
* @result Most recent error code.
*/
Q3_EXTERN_API_C ( TQ3Error )
Q3Error_Get (
TQ3Error *firstError
);
/*!
* @function
* Q3Error_IsFatalError
* @discussion
* Determine whether a Quesa error code is fatal.
*
* You can call this function from an error callback or after getting
* an error code with Q3Error_Get. If the error is fatal, your application
* should quit without calling any other Quesa routines.
*
* @param error A Quesa error code.
* @result True if the error is fatal.
*/
Q3_EXTERN_API_C ( TQ3Boolean )
Q3Error_IsFatalError (
TQ3Error error
);
/*!
* @function
* Q3Warning_Get
* @discussion
* Retrieve latest warning codes from Quesa.
*
* Retrieve the most recent warning code, and optionally also the oldest
* unreported warning code. After this call, the next Quesa call that is not
* part of the Error Manager will clear the warning codes.
*
* @param firstWarning Pointer to variable to receive the oldest warning code
* that has not yet been reported. May be NULL if you
* don't need that information.
* @result Most recent warning code.
*/
Q3_EXTERN_API_C ( TQ3Warning )
Q3Warning_Get (
TQ3Warning *firstWarning
);
/*!
* @function
* Q3Notice_Get
* @discussion
* Retrieve latest notice codes from Quesa.
*
* Retrieve the most recent notice code, and optionally also the oldest
* unreported notice code. After this call, the next Quesa call that is not
* part of the Error Manager will clear the notice codes.
*
* @param firstNotice Pointer to variable to receive the oldest notice code
* that has not yet been reported. May be NULL if you
* don't need that information.
* @result Most recent notice code.
*/
Q3_EXTERN_API_C ( TQ3Notice )
Q3Notice_Get (
TQ3Notice *firstNotice
);
/*!
* @function
* Q3Error_PlatformGet
* @discussion
* Gets platform-specific error codes.
* This is a generalization of Q3MacintoshError_Get, and may be used in place
* of Q3MacintoshError_Get on the Macintosh platform.
*
* If an error callback or Q3Error_Get returns one of the special error codes
* kQ3ErrorMacintoshError, kQ3ErrorWin32Error, kQ3ErrorUnixError,
* kQ3ErrorPlatformError, you can call this function to retrieve
* platform-specific error codes.
* After this call, the next Quesa call that is not part of the Error Manager
* will clear the platform-specific error codes.
*
* This function is not available in QD3D.
*
* @param firstErr Pointer to variable to receive the oldest unreported
* platform-specific error code. May be NULL if you
* don't need that information.
* @result Most recent platform-specific error code.
*/
#if QUESA_ALLOW_QD3D_EXTENSIONS
Q3_EXTERN_API_C ( TQ3Uns32 )
Q3Error_PlatformGet (
TQ3Uns32 *firstErr
);
#endif // QUESA_ALLOW_QD3D_EXTENSIONS
/*!
* @function
* Q3Error_PlatformPost
* @discussion
* Posts a platform-specific error code.
*
* Normally this would be used only by Quesa plug-ins, not by application code.
*
* This function is not available in QD3D.
*
* @param theErr A platform-specific error code.
*/
#if QUESA_ALLOW_QD3D_EXTENSIONS
Q3_EXTERN_API_C ( void )
Q3Error_PlatformPost (
TQ3Uns32 theErr
);
#endif // QUESA_ALLOW_QD3D_EXTENSIONS
/*!
* @function
* Q3Error_ToString
* @discussion
* Retrieve a string version of the error code.
*
* This function is not available in QD3D.
*
* @param theLanguage Preferred language for the error string.
* Currently only English is supported.
* @param theError Quesa error code.
* @result Text version of the error code, as a NULL-terminated string.
*/
#if QUESA_ALLOW_QD3D_EXTENSIONS
Q3_EXTERN_API_C ( const char * )
Q3Error_ToString (
TQ3Language theLanguage,
TQ3Error theError
);
#endif // QUESA_ALLOW_QD3D_EXTENSIONS
/*!
* @function
* Q3Warning_ToString
* @discussion
* Retrieve a string version of the warning code.
*
* This function is not available in QD3D.
*
* @param theLanguage Preferred language for the warning string.
* Currently only English is supported.
* @param theWarning Quesa warning code.
* @result Text version of the warning code, as a NULL-terminated string.
*/
#if QUESA_ALLOW_QD3D_EXTENSIONS
Q3_EXTERN_API_C ( const char * )
Q3Warning_ToString (
TQ3Language theLanguage,
TQ3Warning theWarning
);
#endif // QUESA_ALLOW_QD3D_EXTENSIONS
/*!
* @function
* Q3Notice_ToString
* @discussion
* Retrieve a string version of the notice code.
*
* This function is not available in QD3D.
*
* @param theLanguage Preferred language for the notice string.
* Currently only English is supported.
* @param theWarning Quesa notice code.
* @result Text version of the notice code, as a NULL-terminated string.
*/
#if QUESA_ALLOW_QD3D_EXTENSIONS
Q3_EXTERN_API_C ( const char * )
Q3Notice_ToString (
TQ3Language theLanguage,
TQ3Notice theError
);
#endif // QUESA_ALLOW_QD3D_EXTENSIONS
//=============================================================================
// Mac OS function prototypes
//-----------------------------------------------------------------------------
#if QUESA_OS_MACINTOSH
/*!
* @function
* Q3MacintoshError_Get
* @discussion
* Retrieve the most recent Macintosh error code, and optionally also the oldest
* unreported Mac error code. After this call, the next Quesa call that is not
* part of the Error Manager will clear the error codes.
*
* Q3Error_PlatformGet may be used in place of this function.
*
* @param firstMacErr Pointer to variable to receive the oldest Mac error code
* that has not yet been reported. May be NULL if you
* don't need that information.
* @result Most recent Mac error code.
*/
Q3_EXTERN_API_C ( OSErr )
Q3MacintoshError_Get (
OSErr *firstMacErr
);
#endif // QUESA_OS_MACINTOSH
//=============================================================================
// C++ postamble
//-----------------------------------------------------------------------------
#ifdef __cplusplus
}
#endif
#endif