Query

Description

This optional callback is used by the Render Manager to query the rendering engine for information based on the siRenderQueryType enumeration value given in the QueryType attribute.

Applies To

Custom Renderers

Syntax

    // C++
    CStatus <renderer_name>_Query( CRef& in_context )
    {
       ...
    }

<renderer_name> is the name specified in the call to RegisterRenderer with any spaces removed.

Parameters

Parameter | Language | Type | Description
in_context | C++ | CRef & | A reference to the RendererContext object. Context::GetSource returns the Renderer .

Context Attributes

Attribute | Type | Description
QueryType | siRenderQueryType | The type of information being queried for. Depending on the type of information being queried, certain additional attributes are available (see below).
Filename | CString | Filename for an object archive.
siRenderQueryArchiveIsValid
Valid | bool | On return should be set as a boolean value indicating whether the object archive given in Filename is a valid archive (true) or not (false).
MultiFrame | bool | On return should be set as a Boolean value indicating whether the archive, if valid, is a multi-frame archive (true) or not (false).
siRenderQueryArchiveProxies
Frame | int | The frame number within the archive that the proxies should be returned for. Only needed for multi-frame archives. For single-frame archives, the Filename attribute value is sufficient.
ProxyXY ProxyXZ ProxyYZ | CString | If display proxies were generated for the object archive given in Filename, these attribute values should be set by the callback, as a CString with absolute paths for the display proxies for the XY, XZ and YZ planes. The display proxies are drawn to fit the bounding box of the archive. The display proxy images should be saved in a format that Softimage recognises.
siRenderQueryArchiveBBox
Frame | int | The frame number within the archive that the bounding box should be returned for. Only needed for multi-frame archives. For single-frame archives, the Filename attribute value is sufficient.
BBoxMin BBoxMax | CVector3 | These attribute values should be set by the callback as the full bounding box of the renderable geometry contained inside the object archive. The minimum and maximum extents should be set as CVector3 values for an axis-aligned bounding box.
siRenderQueryArchiveFrameRange
FrameStart FrameEnd | int | These attribute values should be set by the callback as the frame range for the multi-frame object archive given by the Filename attribute. This is only called if the callback has identified the object archive as a multi-frame archive. Both values are inclusive.
siRenderQueryDisplayBitDepths
BitDepths | CLongArray | This attribute should be set by the callback as an array of siImageBitDepth values, indicating which bit depths Softimage can ask the renderer to return image fragments for (see RendererImageFragment::GetScanlineRGBA). Values currently understood by Softimage are: • siImageBitDepthInteger8 • siImageBitDepthInteger16 • siImageBitDepthFloat16 • siImageBitDepthFloat32

See Also

• Init (Renderer)

• Process

• Abort

• Cleanup

• Quality

• Renderer Callbacks

Autodesk Softimage v7.5