Functions

Q3HitPath_EmptyData

( TQ3Status ) Q3HitPath_EmptyData (
    TQ3HitPath *hitPath
);

Discussion

Release the memory allocated by a previous call to Q3Pick_GetPickDetailData.

Parameter Descriptions

hitPath
The hit-path data to release.

function result: Success or failure of the operation.

Q3MeshEdgePart_GetEdge

( TQ3Status ) Q3MeshEdgePart_GetEdge (
    TQ3MeshEdgePartObject meshEdgePartObject,
    TQ3MeshEdge *edge
);

Discussion

Get the mesh edge that corresponds to a mesh edge part.

Parameter Descriptions

meshEdgePartObject
The mesh edge to query.

edge
Receives the mesh edge that corresponds to meshEdgePartObject.

function result: Success or failure of the operation.

Q3MeshFacePart_GetFace

( TQ3Status ) Q3MeshFacePart_GetFace (
    TQ3MeshFacePartObject meshFacePartObject,
    TQ3MeshFace *face
);

Discussion

Get the mesh face that corresponds to a mesh face part.

Parameter Descriptions

meshFacePartObject
The mesh face to query.

face
Receives the mesh face that corresponds to meshFacePartObject.

function result: Success or failure of the operation.

Q3MeshPart_GetComponent

( TQ3Status ) Q3MeshPart_GetComponent (
    TQ3MeshPartObject meshPartObject,
    TQ3MeshComponent *component
);

Discussion

Get the mesh component that contains a mesh part object.

Parameter Descriptions

meshPartObject
The mesh part to query.

component
Receives the mesh component that contains meshPartObject.

function result: Success or failure of the operation.

Q3MeshPart_GetType

( TQ3ObjectType ) Q3MeshPart_GetType (
    TQ3MeshPartObject meshPartObject
);

Discussion

Get the type of a mesh part object.

Returns kQ3MeshPartTypeMeshFacePart, kQ3MeshPartTypeMeshEdgePart, or kQ3MeshPartTypeMeshVertexPart. If the type can not be determined, returns kQ3ObjectTypeInvalid.

Parameter Descriptions

meshPartObject
The mesh part to query.

function result: The type of the mesh part.

Q3MeshVertexPart_GetVertex

( TQ3Status ) Q3MeshVertexPart_GetVertex (
    TQ3MeshVertexPartObject meshVertexPartObject,
    TQ3MeshVertex *vertex
);

Discussion

Get the mesh vertex that corresponds to a mesh vertex part.

Parameter Descriptions

meshVertexPartObject
The mesh vertex to query.

vertex
Receives the mesh vertex that corresponds to meshVertedPartObject.

function result: Success or failure of the operation.

Q3Pick_EmptyHitList

( TQ3Status ) Q3Pick_EmptyHitList (
    TQ3PickObject pick
);

Discussion

Empty the hit list of a pick object.

Parameter Descriptions

pick
The pick object to update.

function result: Success or failure of the operation.

Q3Pick_GetData

( TQ3Status ) Q3Pick_GetData (
    TQ3PickObject pick,
    TQ3PickData *data
);

Discussion

Get the common state of a pick object.

Parameter Descriptions

pick
The pick object to query.

data
Receives the common state of the pick object.

function result: Success or failure of the operation.

Q3Pick_GetEdgeTolerance

( TQ3Status ) Q3Pick_GetEdgeTolerance (
    TQ3PickObject pick,
    float *edgeTolerance
);

Discussion

Get the edge tolerance of a pick object.

Parameter Descriptions

pick
The pick object to query.

edgeTolerance
Receives the edge tolerance of the pick object.

function result: Success or failure of the operation.

Q3Pick_GetNumHits

( TQ3Status ) Q3Pick_GetNumHits (
    TQ3PickObject pick,
    TQ3Uns32 *numHits
);

Discussion

Get the number of hits of a pick object.

Parameter Descriptions

pick
The pick object to query.

numHits
Receives the number of hits of a pick object.

function result: Success or failure of the operation.

Q3Pick_GetPickDetailData

( TQ3Status ) Q3Pick_GetPickDetailData (
    TQ3PickObject pick,
    TQ3Uns32 index,
    TQ3PickDetail pickDetailValue,
    void *detailData
);

Discussion

Get the data for a pick result.

When the kQ3PickDetailMaskPath data is requested, it must be disposed of by the caller using Q3HitPath_EmptyData.

Pick results are indexed from 0, and the number of available pick results is returned by Q3Pick_GetNumHits.

Parameter Descriptions

pick
The pick object to query.

index
The index of the hit to query.

pickDetailValue
The type of data requested from the hit.

detailData
Receives the data from the hit.

function result: Success or failure of the operation.

Q3Pick_GetPickDetailValidMask

( TQ3Status ) Q3Pick_GetPickDetailValidMask (
    TQ3PickObject pick,
    TQ3Uns32 index,
    TQ3PickDetail *pickDetailValidMask
);

Discussion

Get the available data mask for a pick result.

Pick results are indexed from 0, and the number of available pick results is returned by Q3Pick_GetNumHits.

Parameter Descriptions

pick
The pick object to query.

index
The index of the hit to query.

pickDetailValidMask
Receives the available data mask for the hit.

function result: Success or failure of the operation.

Q3Pick_GetType

( TQ3ObjectType ) Q3Pick_GetType (
    TQ3PickObject pick
);

Discussion

Get the type of a pick object.

Returns kQ3ObjectTypeInvalid if the pick type is unknown.

Parameter Descriptions

pick
The pick to query.

function result: The type of the pick object.

Q3Pick_GetVertexTolerance

( TQ3Status ) Q3Pick_GetVertexTolerance (
    TQ3PickObject pick,
    float *vertexTolerance
);

Discussion

Get the vertex tolerance of a pick object.

Parameter Descriptions

pick
The pick object to query.

vertexTolerance
Receives the vertex tolerance of the pick object.

function result: Success or failure of the operation.

Q3Pick_SetData

( TQ3Status ) Q3Pick_SetData (
    TQ3PickObject pick,
    const TQ3PickData *data
);

Discussion

Set the common state of a pick object.

Parameter Descriptions

pick
The pick object to update.

data
The new common state for the pick object.

function result: Success or failure of the operation.

Q3Pick_SetEdgeTolerance

( TQ3Status ) Q3Pick_SetEdgeTolerance (
    TQ3PickObject pick,
    float edgeTolerance
);

Discussion

Set the edge tolerance of a pick object.

Parameter Descriptions

pick
The pick object to update.

edgeTolerance
The new edge tolerance of the pick object.

function result: Success or failure of the operation.

Q3Pick_SetVertexTolerance

( TQ3Status ) Q3Pick_SetVertexTolerance (
    TQ3PickObject pick,
    float vertexTolerance
);

Discussion

Set the vertex tolerance of a pick object.

Parameter Descriptions

pick
The pick object to update.

vertexTolerance
The new vertex tolerance of the pick object.

function result: Success or failure of the operation.

Q3ShapePart_GetShape

( TQ3Status ) Q3ShapePart_GetShape (
    TQ3ShapePartObject shapePartObject,
    TQ3ShapeObject *shapeObject
);

Discussion

Get the shape object that contains a shape part object.

Parameter Descriptions

shapePartObject
The shape part to query.

shapeObject
Receives the shape object that contains shapePartObject.

function result: Success or failure of the operation.

Q3ShapePart_GetType

( TQ3ObjectType ) Q3ShapePart_GetType (
    TQ3ShapePartObject shapePartObject
);

Discussion

Get the type of a shape part object.

Parameter Descriptions

shapePartObject
The shape part to query.

function result: The type of the shape part.

Q3WindowPointPick_GetData

( TQ3Status ) Q3WindowPointPick_GetData (
    TQ3PickObject pick,
    TQ3WindowPointPickData *data
);

Discussion

Get the data of a window-point pick object.

Parameter Descriptions

pick
The pick object to query.

data
Receives the data of the pick object.

function result: Success or failure of the operation.

Q3WindowPointPick_GetPoint

( TQ3Status ) Q3WindowPointPick_GetPoint (
    TQ3PickObject pick,
    TQ3Point2D *point
);

Discussion

Get the pick point of a window-point pick object.

Parameter Descriptions

pick
The pick object to query.

point
Receives the pick point of the pick object.

function result: Success or failure of the operation.

Q3WindowPointPick_New

( TQ3PickObject ) Q3WindowPointPick_New (
    const TQ3WindowPointPickData *data
);

Discussion

Create a new window-point pick object.

Parameter Descriptions

data
The data for the pick object.

function result: The new pick object.

Q3WindowPointPick_SetData

( TQ3Status ) Q3WindowPointPick_SetData (
    TQ3PickObject pick,
    const TQ3WindowPointPickData *data
);

Discussion

Set the data for a window-point pick object.

Parameter Descriptions

pick
The pick object to update.

data
The new data for the pick object.

function result: Success or failure of the operation.

Q3WindowPointPick_SetPoint

( TQ3Status ) Q3WindowPointPick_SetPoint (
    TQ3PickObject pick,
    const TQ3Point2D *point
);

Discussion

Set the pick point of a window-point pick object.

Parameter Descriptions

pick
The pick object to update.

point
The new pick point for the pick object.

function result: Success or failure of the operation.

Q3WindowRectPick_GetData

( TQ3Status ) Q3WindowRectPick_GetData (
    TQ3PickObject pick,
    TQ3WindowRectPickData *data
);

Discussion

Get the data of a window-rect pick object.

Parameter Descriptions

pick
The pick object to query.

data
Receives the data of the pick object.

function result: Success or failure of the operation.

Q3WindowRectPick_GetRect

( TQ3Status ) Q3WindowRectPick_GetRect (
    TQ3PickObject pick,
    TQ3Area *rect
);

Discussion

Get the pick rect of a window-rect pick object.

Parameter Descriptions

pick
The pick object to query.

rect
Receives the pick rect of the pick object.

function result: Success or failure of the operation.

Q3WindowRectPick_New

( TQ3PickObject ) Q3WindowRectPick_New (
    const TQ3WindowRectPickData *data
);

Discussion

Create a new window-rect pick object.

Parameter Descriptions

data
The data for the pick object.

function result: The new pick object.

Q3WindowRectPick_SetData

( TQ3Status ) Q3WindowRectPick_SetData (
    TQ3PickObject pick,
    const TQ3WindowRectPickData *data
);

Discussion

Set the data of a window-rect pick object.

Parameter Descriptions

pick
The pick object to update.

data
The new data for the pick object.

function result: Success or failure of the operation.

Q3WindowRectPick_SetRect

( TQ3Status ) Q3WindowRectPick_SetRect (
    TQ3PickObject pick,
    const TQ3Area *rect
);

Discussion

Set the pick rect of a window-rect pick object.

Parameter Descriptions

pick
The pick object to update.

rect
The new pick rect of the pick object.

function result: Success or failure of the operation.

Q3WorldRayPick_GetData

( TQ3Status ) Q3WorldRayPick_GetData (
    TQ3PickObject pick,
    TQ3WorldRayPickData *data
);

Discussion

Get the data of a world-ray pick object.

Parameter Descriptions

pick
The pick object to query.

data
Receives the data for the pick object.

function result: Success or failure of the operation.

Q3WorldRayPick_GetRay

( TQ3Status ) Q3WorldRayPick_GetRay (
    TQ3PickObject pick,
    TQ3Ray3D *ray
);

Discussion

Get the pick ray of a world-ray pick object.

Parameter Descriptions

pick
The pick object to query.

ray
Receives the ray of the pick object.

function result: Success or failure of the operation.

Q3WorldRayPick_New

( TQ3PickObject ) Q3WorldRayPick_New (
    const TQ3WorldRayPickData *data
);

Discussion

Create a new world-ray pick object.

Parameter Descriptions

data
The data for the pick object.

function result: The new pick object.

Q3WorldRayPick_SetData

( TQ3Status ) Q3WorldRayPick_SetData (
    TQ3PickObject pick,
    const TQ3WorldRayPickData *data
);

Discussion

Set the data of a world-ray pick object.

Parameter Descriptions

pick
The pick object to update.

data
The new data for the pick object.

function result: Success or failure of the operation.

Q3WorldRayPick_SetRay

( TQ3Status ) Q3WorldRayPick_SetRay (
    TQ3PickObject pick,
    const TQ3Ray3D *ray
);

Discussion

Set the pick ray of a world-ray pick object.

Parameter Descriptions

pick
The pick object to update.

ray
The new ray for the pick object.

function result: Success or failure of the operation.