Returns visual overridden preview image for and element

    GSErrCode  ACAPI_Element_GetVisualOverriddenImage (
        const API_Guid&                elemGuid,
        API_VisualOverriddenImage*     image
    );

 

Parameters

elemGuid

[in] Element reference.

image

[in/out] Visual overridden image descriptor.

 

Return Values

APIERR_BADID

The element reference is invalid (guid).

APIERR_BADPARS

The passed image parameter was nullptr.

NoError

The function has completed with success.

For other common API errors see the API Errors document.

 

Remarks

The output preview image shows an element without concrete geometry and connected elements. Outputs are a vector image and a native image.
Do not forget to dispose the handle of the output vector image if it is not needed any more.
See API_VisualOverriddenImage structure for further details.

 

Example

// Copied from Override_Test example Add-On
API_VisualOverriddenImage image;
BNZeroMemory (&image, sizeof (API_VisualOverriddenImage));
image.view = APIImage_Section;
image.overrideStyle.uncutSurfaceType.overridden = true;
image.overrideStyle.uncutSurfaceType.attributeIndex = 5; // Stone - Limestone Fine
NewDisplay::NativeImage sectionNativeImage (250, 250, 32, nullptr);
image.nativeImagePtr = &sectionNativeImage;

err = ACAPI_Element_GetVisualOverriddenImage (api_elemGuid, &image);
if (err != NoError)
    ErrorBeep ("ACAPI_Element_GetVisualOverriddenImage (APIImage_Section)", err);
else
    DumpVectorImage (image);
BMhFree (image.vectorImageHandle);

 

Requirements

Version: API 20 or later

Header: ACAPinc.h

 

See Also

API Functions