QuesaCustomElements.h

Discussion

Declares the standard Quesa custom elements, most inherited from QD3D.

Functions

CENameElement_EmptyData

( TQ3Status ) CENameElement_EmptyData (
    char **name
);

Discussion

Release the data returned by CENameElement_GetData.

Parameter Descriptions

name
A pointer previously returned by CENameElement_GetData.

function result: Success or failure of the operation.

CENameElement_GetData

( TQ3Status ) CENameElement_GetData (
    TQ3Object object,
    char **name
);

Discussion

Get the name element for an object.

The name parameter will receive a C string, or NULL if no name has been associated with the object. If a non-NULL pointer is returned, it must be disposed of with CENameElement_EmptyData.

Parameter Descriptions

object
The object to query.

name
Receives the name associated with the object.

function result: Success or failure of the operation.

CENameElement_PeekData

Availability: This function is not available in QD3D.

( TQ3Status ) CENameElement_PeekData (
    TQ3Object object,
    const char **name
);

Discussion

Get the name element for an object.

The name parameter will receive a C string, or NULL if no name has been associated with the object. If a non-NULL pointer is returned, it should be considered read-only and temporary. Unlike CENameElement_GetData, this function returns the actual string within the element, not a copy.

Parameter Descriptions

object
The object to query.

name
Receives the name associated with the object.

function result: Success or failure of the operation.

CENameElement_SetData

( TQ3Status ) CENameElement_SetData (
    TQ3Object object,
    const char *name
);

Discussion

Set the name element for an object.

The name parameter should point to a C string, and will be copied by CENameElement_SetData.

Parameter Descriptions

object
The object to assign the name to.

name
The C string to associate with the object.

function result: Success or failure of the operation.

CETriangleStripElement_GetData

Get a triangle strip for the object.

( TQ3Status ) CETriangleStripElement_GetData (
    TQ3Object inObject,
    TQ3Uns32* outNumIndices,
    const TQ3Uns32** outIndices
);

Discussion

Triangle strips are used by the OpenGL renderer as a speed optimization for rendering TriMesh objects.

If the current edit index of the object is not the same as when a strip was assigned, the strip will be considered stale and this function will return kQ3Failure.

This function returns the actual triangle strip data within the element, not a copy. The data should be considered read-only and temporary.

This function is not available in QD3D.

Parameter Descriptions

inObject
An object, normally a TriMesh.

outNumIndices
Receives count of indices.

outIndices
Receives address of array of vertex indices.

function result: Success or failure of the operation.

CETriangleStripElement_Remove

Remove a triangle strip element if it exists.

(void) CETriangleStripElement_Remove (
    TQ3Object ioObject
);

Parameter Descriptions

ioObject
An object, normally a TriMesh.

CETriangleStripElement_SetData

Set a triangle strip for the object.

( TQ3Status ) CETriangleStripElement_SetData (
    TQ3Object ioObject,
    TQ3Uns32 inNumIndices,
    const TQ3Uns32* inIndices
);

Discussion

Triangle strips are used by the OpenGL renderer as a speed optimization for rendering TriMesh objects. If you have not already provided a triangle strip for a TriMesh, the renderer will compute one, but this can take a little time.

When you assign a triangle strip, the element also records the current edit index of the object.

You can pass 0 for inNumIndices and NULL for inIndices to indicate that you want to avoid using a triangle strip, perhaps because there is no efficient strip for this geometry.

This function is not available in QD3D.

Parameter Descriptions

ioObject
An object, normally a TriMesh.

inNumIndices
Count of indices in the following array.

inIndices
Array of vertex indices making the strip.

function result: Success or failure of the operation.

CEUrlElement_EmptyData

( TQ3Status ) CEUrlElement_EmptyData (
    TCEUrlData **urlData
);

Discussion

Release the data returned by CEUrlElement_GetData.

Parameter Descriptions

urlData
A pointer previously returned by CEUrlElement_GetData.

function result: Success or failure of the operation.

CEUrlElement_GetData

( TQ3Status ) CEUrlElement_GetData (
    TQ3Object object,
    TCEUrlData **urlData
);

Discussion

Get the URL element for an object.

The urlData parameter will receive a pointer to the URL data, or NULL if no URL element has been associated with the object. If a non-NULL pointer is returned, it must be disposed of with CEUrlElement_EmptyData.

Parameter Descriptions

object
The object to retrieve the URL element from.

urlData
Receives the URL data.

function result: Success or failure of the operation.

CEUrlElement_SetData

( TQ3Status ) CEUrlElement_SetData (
    TQ3Object object,
    TCEUrlData *urlData
);

Discussion

Set the URL element for an object.

The URL element data will be copied by CEUrlElement_SetData.

Parameter Descriptions

object
The object to assign the URL element to.

urlData
The URL data to associate with the object.

function result: Success or failure of the operation.

CEWireElement_EmptyData

( TQ3Status ) CEWireElement_EmptyData (
    QTAtomContainer *wireData
);

Discussion

Release the data returned by CEWireElement_GetData.

Parameter Descriptions

wireData
A pointer previously returned by CEWireElement_GetData.

function result: Success or failure of the operation.

CEWireElement_GetData

( TQ3Status ) CEWireElement_GetData (
    TQ3Object object,
    QTAtomContainer *wireData
);

Discussion

Get the QuickTime wired element for an object.

The wireData parameter will receive a QTAtomContainer, or NULL if no wired element has been associated with the object. If a non-NULL pointer is returned, it must be disposed of with CEWireElement_EmptyData.

Parameter Descriptions

object
The object to query.

wireData
Receives the QuickTime wired element associated with the object.

function result: Success or failure of the operation.

CEWireElement_SetData

( TQ3Status ) CEWireElement_SetData (
    TQ3Object object,
    QTAtomContainer wireData
);

Discussion

Set the QuickTime wired element for an object.

Parameter Descriptions

object
The object to assign the element to.

wireData
The QuickTime wired element to associate with the object.

function result: Success or failure of the operation.

Constants

CEcNameElementName

Discussion

Class name of the name element.

Ordinarily you will not need to use the class name, because you can manipulate name elements using the functions CENameElement_SetData, CENameElement_GetData, and CENameElement_EmptyData.

CEcUrlElementName

Discussion

Class name of the URL element.

Ordinarily you will not need to use the class name, because you can manipulate name elements using the functions CEUrlElement_SetData, CEUrlElement_GetData, and CEUrlElement_EmptyData.

CEcWireElementName

Discussion

Class name of the wire element.

Ordinarily you will not need to use the class name, because you can manipulate name elements using the functions CEWireElement_SetData, CEWireElement_GetData, and CEWireElement_EmptyData.

kQ3ClassNameCustomElementTriangleStrip

Class name of the triangle strip custom element.

Discussion

Ordinarily you will not need to use the class name, because you can manipulate triangle strip elements using the functions CETriangleStripElement_SetData, CETriangleStripElement_GetData.

Structs

TCEUrlData

typedef struct TCEUrlData {
    char                                        *url;
    char                                        *description;
    TCEUrlOptions                               options;
} TCEUrlData;

Discussion

Describes the data for a URL.

Field Descriptions

url
C string containing the full (scheme + path) URL.

description
Human readable description of the URL.

options
Options for the URL.

Enumerations

TCEUrlOptions

typedef enum {
    kCEUrlOptionNone                            = 0,
    kCEUrlOptionUseMap                          = 1,
    kCEUrlOptionSize32                          = 0xFFFFFFFF
} TCEUrlOptions;

Discussion

URL options.

Constants

kCEUrlOptionNone
No options set.

kCEUrlOptionUseMap
Map option set (meaning unknown).