Functions

CQ3AttributeSet_GetSurfaceShader

inline CQ3ObjectRef CQ3AttributeSet_GetSurfaceShader (
    TQ3AttributeSet inSet
);

Discussion

Get the surface shader from an attribute set.

Parameter Descriptions

inSet
An attribute set.

function result: A surface shader or NULL.

CQ3Box_GetFaceAttributeSet

inline CQ3ObjectRef CQ3Box_GetFaceAttributeSet (
    TQ3GeometryObject box,
    TQ3Uns32 faceIndex
);

Discussion

Gets the attribute set associated with a certain face of a box object.

Parameter Descriptions

box
A reference to a box geometry object.

faceIndex
The index of the face of the box, between 0 and 5 (inclusive).

function result: The attribute set of the box face, or NULL if the face does not have an attribute set.

CQ3Cone_GetBottomAttributeSet

inline CQ3ObjectRef CQ3Cone_GetBottomAttributeSet (
    TQ3GeometryObject cone
);

Discussion

Get the attribute set for the bottom cap of a cone object.

Parameter Descriptions

cone
The cone object.

function result: The bottom attribute set, or NULL.

CQ3Cone_GetFaceAttributeSet

inline CQ3ObjectRef CQ3Cone_GetFaceAttributeSet (
    TQ3GeometryObject cone
);

Discussion

Get the attribute set for the face (as opposed to the bottom cap) of a cone.

Parameter Descriptions

cone
The cone object.

function result: The face attribute set, or NULL.

CQ3Cone_GetInteriorAttributeSet

inline CQ3ObjectRef CQ3Cone_GetInteriorAttributeSet (
    TQ3GeometryObject cone
);

Discussion

Get the attribute set for the interior of a cone object.

Parameter Descriptions

cylinder
A cone object.

function result: The attribute set for the interior, or NULL.

CQ3Cylinder_GetBottomAttributeSet

inline CQ3ObjectRef CQ3Cylinder_GetBottomAttributeSet (
    TQ3GeometryObject cylinder
);

Discussion

Get the attribute set for the bottom cap of a cylinder object.

Parameter Descriptions

cylinder
A cylinder object.

function result: The attribute set for the bottom cap, or NULL.

CQ3Cylinder_GetFaceAttributeSet

inline CQ3ObjectRef CQ3Cylinder_GetFaceAttributeSet (
    TQ3GeometryObject cylinder
);

Discussion

Get the attribute set for the face of a cylinder object (i.e., neither end)

Parameter Descriptions

cylinder
A cylinder object.

function result: The attribute set for the face, or NULL.

CQ3Cylinder_GetInteriorAttributeSet

inline CQ3ObjectRef CQ3Cylinder_GetInteriorAttributeSet (
    TQ3GeometryObject cylinder
);

Discussion

Get the attribute set for the interior of a cylinder object.

Parameter Descriptions

cylinder
A cylinder object.

function result: The attribute set for the interior, or NULL.

CQ3Cylinder_GetTopAttributeSet

inline CQ3ObjectRef CQ3Cylinder_GetTopAttributeSet (
    TQ3GeometryObject cylinder
);

Discussion

Get the attribute set for the top cap of a cylinder object.

Parameter Descriptions

cylinder
A cylinder object.

function result: The attribute set for the top cap, or NULL.

CQ3File_GetStorage

inline CQ3ObjectRef CQ3File_GetStorage (
    TQ3FileObject theFile
);

Discussion

Get the storage object for a file.

Parameter Descriptions

theFile
The file to query.

function result: The storage object for the file.

CQ3GeneralPolygon_GetVertexAttributeSet

inline CQ3ObjectRef CQ3GeneralPolygon_GetVertexAttributeSet (
    TQ3GeometryObject generalPolygon,
    TQ3Uns32 contourIndex,
    TQ3Uns32 pointIndex
);

Discussion

Get the attribute set of a vertex of a general polygon.

Parameter Descriptions

generalPolygon
A general polygon object.

contourIndex
A 0-based index into the array of contours.

pointIndex
A 0-based index into the array of vertices of a contour.

function result: The vertex attribute set, or NULL.

CQ3Geometry_GetAttributeSet

inline CQ3ObjectRef CQ3Geometry_GetAttributeSet (
    TQ3GeometryObject geometry
);

Discussion

Returns the attribute set associated with a geometric object.

Parameter Descriptions

geometry
A reference to a geometry object.

function result: The attribute set of the geometry.

CQ3Group_GetPositionObject

inline CQ3ObjectRef CQ3Group_GetPositionObject (
    TQ3GroupObject group,
    TQ3GroupPosition position
);

Discussion

Get the object located at a certain position in a group.

This function obtains a reference to the group member at a specified position.

Returns NULL if there is no object at the given position.

Parameter Descriptions

group
Group to inspect.

position
Position of desired object.

function result: The indicated object.

CQ3HighlightStyle_Get

inline CQ3ObjectRef CQ3HighlightStyle_Get (
    TQ3StyleObject highlight
);

Discussion

Get the data from a highlight style.

Parameter Descriptions

highlight
The style to query.

function result: The data from the style.

CQ3Line_GetVertexAttributeSet

inline CQ3ObjectRef CQ3Line_GetVertexAttributeSet (
    TQ3GeometryObject line,
    TQ3Uns32 index
);

Discussion

Get the attribute set of one of the ends of a line object.

Parameter Descriptions

line
A line object.

index
An index, 0 or 1, specifying an end of the line.

function result: The attribute set, or NULL.

CQ3Mesh_GetCornerAttributeSet

inline CQ3ObjectRef CQ3Mesh_GetCornerAttributeSet (
    TQ3GeometryObject mesh,
    TQ3MeshVertex vertex,
    TQ3MeshFace face
);

Discussion

Get the attribute set of a mesh corner.

Parameter Descriptions

mesh
The mesh to query.

vertex
The vertex to query.

face
The face to query.

function result: The attribute set of the mesh corner.

CQ3Mesh_GetEdgeAttributeSet

inline CQ3ObjectRef CQ3Mesh_GetEdgeAttributeSet (
    TQ3GeometryObject mesh,
    TQ3MeshEdge edge
);

Discussion

Get the attribute set of a mesh edge.

Parameter Descriptions

mesh
The mesh to query.

face
The face to query.

function result: The attribute set of the mesh face.

CQ3Mesh_GetFaceAttributeSet

inline CQ3ObjectRef CQ3Mesh_GetFaceAttributeSet (
    TQ3GeometryObject mesh,
    TQ3MeshFace face
);

Discussion

Get the attribute set of a mesh face.

Parameter Descriptions

mesh
The mesh to query.

face
The face to query.

function result: The attribute set of the mesh face.

CQ3Mesh_GetVertexAttributeSet

inline CQ3ObjectRef CQ3Mesh_GetVertexAttributeSet (
    TQ3GeometryObject mesh,
    TQ3MeshVertex vertex
);

Discussion

Get the attribute set of a mesh vertex.

Parameter Descriptions

mesh
The mesh to query.

vertex
The vertex to query.

function result: The attribute set of the mesh vertex.

CQ3Object_GetSet

inline CQ3ObjectRef CQ3Object_GetSet (
    TQ3Object inObject
);

Discussion

Get the element set of an object. This is not the same as the set returned by Q3Shape_GetSet.

This function is primarily for the use of file format plug-ins. Most applications will not need it.

Parameter Descriptions

inObject
The object.

function result: A set object, or NULL.

CQ3PolyLine_GetSegmentAttributeSet

inline CQ3ObjectRef CQ3PolyLine_GetSegmentAttributeSet (
    TQ3GeometryObject polyLine,
    TQ3Uns32 index
);

Discussion

Get the attribute set of a polyline segment.

Parameter Descriptions

polyLine
The polyline to query.

index
The index of the segment to query.

function result: The attribute set of the polyline segment.

CQ3PolyLine_GetVertexAttributeSet

inline CQ3ObjectRef CQ3PolyLine_GetVertexAttributeSet (
    TQ3GeometryObject polyLine,
    TQ3Uns32 index
);

Discussion

Get the attribute set of a polyline vertex.

Parameter Descriptions

polyLine
The polyline to query.

index
The index of the vertex to query.

function result: The attribute set of the polyline vertex.

CQ3Polygon_GetVertexAttributeSet

inline CQ3ObjectRef CQ3Polygon_GetVertexAttributeSet (
    TQ3GeometryObject polygon,
    TQ3Uns32 index
);

Discussion

Get the attribute set of a vertex in a polygon object.

Parameter Descriptions

polygon
A polygon object.

index
A 0-based index into the array of vertices of the polygon.

function result: The attribute set, or NULL.

CQ3Polyhedron_GetVertexAttributeSet

inline CQ3ObjectRef CQ3Polyhedron_GetVertexAttributeSet (
    TQ3GeometryObject polyhedron,
    TQ3Uns32 index
);

Discussion

Get the position of a polyhedron vertex.

Parameter Descriptions

polyhedron
The polyhedron to query.

index
The index of the vertex to query.

function result: The attribute set of the vertex.

CQ3Shape_GetSet

inline CQ3ObjectRef CQ3Shape_GetSet (
    TQ3ShapeObject inObject
);

Discussion

Get the set element currently associated with a shape. The function call Q3Shape_GetSet( o, &s ) is equivalent to Q3Shape_GetElement( o, kQ3ElementTypeSet, &s ).

Note that this is not the same as the attribute set of a geometry object, nor is in the internal set which holds elements on an object. That is, after adding elements or attributes to an object, this function may still return the NULL set.

Parameter Descriptions

shape
The object to query.

theSet
Receives the set of the object, or NULL.

function result: Success or failure of the operation.

CQ3TextureShader_GetTexture

inline CQ3ObjectRef CQ3TextureShader_GetTexture (
    TQ3ShaderObject shader
);

Discussion

Get the texture from a texture shader.

Parameter Descriptions

shader
The shader to query.

function result: The texture from the texture shader.

CQ3Triangle_GetVertexAttributeSet

inline CQ3ObjectRef CQ3Triangle_GetVertexAttributeSet (
    TQ3GeometryObject triangle,
    TQ3Uns32 index
);

Discussion

Get the attribute set of a triangle vertex.

Parameter Descriptions

triangle
The triangle to query.

index
The index of the vertex to query.

function result: The attribute set of the triangle vertex.

CQ3ViewHints_GetAttributeSet

inline CQ3ObjectRef CQ3ViewHints_GetAttributeSet (
    TQ3ViewHintsObject viewHints
);

Discussion

Get the attribute set from a view hints object.

Parameter Descriptions

viewHints
The view hints to query.

function result: The attribute set from the view hints.

CQ3ViewHints_GetCamera

inline CQ3ObjectRef CQ3ViewHints_GetCamera (
    TQ3ViewHintsObject viewHints
);

Discussion

Get the camera from a view hints object.

Parameter Descriptions

viewHints
The view hints to query.

function result: The camera from the view hints.

CQ3ViewHints_GetLightGroup

inline CQ3ObjectRef CQ3ViewHints_GetLightGroup (
    TQ3ViewHintsObject viewHints
);

Discussion

Get the light group from a view hints object.

Parameter Descriptions

viewHints
The view hints to query.

function result: The light group from the view hints.

CQ3ViewHints_GetRenderer

inline CQ3ObjectRef CQ3ViewHints_GetRenderer (
    TQ3ViewHintsObject viewHints
);

Discussion

Get the renderer from a view hints object.

Parameter Descriptions

viewHints
The view hints to query.

function result: The renderer from the view hints.

CQ3View_GetAttributeSetState

inline CQ3ObjectRef CQ3View_GetAttributeSetState (
    TQ3ViewObject view
);

Discussion

Get the current attribute state set from a view.

Parameter Descriptions

view
The view to query.

function result: The current attribute state set associated with the view.

CQ3View_GetCamera

inline CQ3ObjectRef CQ3View_GetCamera (
    TQ3ViewObject view
);

Discussion

Get the camera from a view.

Parameter Descriptions

view
The view to query.

function result: The camera associated with the view.

CQ3View_GetDefaultAttributeSet

inline CQ3ObjectRef CQ3View_GetDefaultAttributeSet (
    TQ3ViewObject view
);

Discussion

Get the default attribute set from a view.

Parameter Descriptions

view
The view to query.

function result: The default attribute set associated with the view.

CQ3View_GetDrawContext

inline CQ3ObjectRef CQ3View_GetDrawContext (
    TQ3ViewObject view
);

Discussion

Get the draw context from a view.

Parameter Descriptions

view
The view to query.

function result: The draw context associated with the view.

CQ3View_GetLightGroup

inline CQ3ObjectRef CQ3View_GetLightGroup (
    TQ3ViewObject view
);

Discussion

Get the light group from a view.

Parameter Descriptions

view
The view to query.

function result: The light group associated with the view.

CQ3View_GetRenderer

inline CQ3ObjectRef CQ3View_GetRenderer (
    TQ3ViewObject view
);

Discussion

Get the renderer from a view.

Parameter Descriptions

view
The view to query.

function result: The renderer associated with the view.