A3DSDKGraphics.h File Reference

Header file for the Graphics. More...

Data Structures

struct  A3DGraphAmbientLightData
 Data for an ambient light source entity (``) More...
 
struct  A3DGraphCameraData
 A complete description of a view point within a three-dimensional space (A3DGraphCamera). More...
 
struct  A3DGraphDirectionalLightData
 Data for a directional light source entity (A3DGraphDirectionalLight) More...
 
struct  A3DGraphDottingPatternData
 Dotting fill pattern descriptor. More...
 
struct  A3DGraphHatchingPatternData
 Hatching lines fill pattern descriptor. More...
 
struct  A3DGraphHatchingPatternLineData
 Line descriptor for the A3DGraphHatchingPatternData structure. More...
 
struct  A3DGraphicsData
 Main description of graphics properties within an A3DRootBaseWithGraphics instance. More...
 
struct  A3DGraphLinePatternData
 2D line pattern descriptor. More...
 
struct  A3DGraphMaterialData
 Material properties descriptor. More...
 
struct  A3DGraphPictureData
 A description of a two-dimensional picture. More...
 
struct  A3DGraphPointLightData
 Data for a point light source entity (A3DGraphPointLight) More...
 
struct  A3DGraphRgbColorData
 Utility class for manipulating RGB color data. More...
 
struct  A3DGraphSceneDisplayParametersData
 Entity for describing the view and shading properties of a graphics scene (A3DGraphSceneDisplayParameters). More...
 
struct  A3DGraphSolidPatternData
 A fill pattern describing either a simple color or a material. More...
 
struct  A3DGraphSpotLightData
 Data for a spotlight source entity (A3DGraphSpotLight) More...
 
struct  A3DGraphStyleData
 General style information. More...
 
struct  A3DGraphVPicturePatternData
 A fill pattern using a vectorized picture. More...
 
struct  A3DMiscCascadedAttributesData
 Describes inheritable properties of a model file node (A3DMiscCascadedAttributes) More...
 

Functions

A3DStatus A3DGlobalGetGraphDottingPatternData (const A3DUns32 uiIndexDottingPattern, A3DGraphDottingPatternData *pData)
 Retrieves an A3DGraphDottingPatternData instance. More...
 
A3DStatus A3DGlobalGetGraphHatchingPatternData (const A3DUns32 uiIndexHatchingPattern, A3DGraphHatchingPatternData *pData)
 Retrieves an A3DGraphHatchingPatternData instance. More...
 
A3DStatus A3DGlobalGetGraphLinePatternData (const A3DUns32 uiIndexLinePattern, A3DGraphLinePatternData *pData)
 Retrieves a line pattern descriptor. More...
 
A3DStatus A3DGlobalGetGraphMaterialData (const A3DUns32 uiIndexMaterial, A3DGraphMaterialData *pData)
 Retrieves an indexed RGB color. More...
 
A3DStatus A3DGlobalGetGraphPictureData (const A3DUns32 uiIndexPicture, A3DGraphPictureData *pData)
 Retrieves an A3DGraphPictureData instance. More...
 
A3DStatus A3DGlobalGetGraphRgbColorData (const A3DUns32 uiIndexRgbColor, A3DGraphRgbColorData *pData)
 Retrieves an indexed RGB color. More...
 
A3DStatus A3DGlobalGetGraphSolidPatternData (const A3DUns32 uiIndexSolidPattern, A3DGraphSolidPatternData *pData)
 Retrieves an A3DGraphHatchingPatternData instance. More...
 
A3DStatus A3DGlobalGetGraphStyleData (const A3DUns32 uiIndexStyle, A3DGraphStyleData *pData)
 Retrieves an indexed graph style. More...
 
A3DStatus A3DGlobalGetGraphVPicturePatternData (const A3DUns32 uiIndexVPicturePattern, A3DGraphVPicturePatternData *pData)
 Retrieves an A3DGraphVPicturePatternData instance. More...
 
A3DStatus A3DGlobalInsertGraphDottingPattern (const A3DGraphDottingPatternData *pData, A3DUns32 *puiIndexDottingPattern)
 Insert a new dotting pattern into the global state, returning its index. More...
 
A3DStatus A3DGlobalInsertGraphHatchingPattern (const A3DGraphHatchingPatternData *pData, A3DUns32 *puiIndexHatchingPattern)
 Insert a new hatching lines fill pattern into the global state, returning its index for further retrieval. More...
 
A3DStatus A3DGlobalInsertGraphLinePattern (const A3DGraphLinePatternData *pData, A3DUns32 *puiIndexLinePattern)
 Creates a line pattern, returning its index. More...
 
A3DStatus A3DGlobalInsertGraphMaterial (const A3DGraphMaterialData *pData, A3DUns32 *puiIndexMaterial)
 Creates a new material, returning its index. More...
 
A3DStatus A3DGlobalInsertGraphPicture (const A3DGraphPictureData *pData, A3DUns32 *puiPictureIndex)
 Insert a new picture into the global state, returning its index. More...
 
A3DStatus A3DGlobalInsertGraphRgbColor (const A3DGraphRgbColorData *pData, A3DUns32 *puiIndexRgbColor)
 Creates a new indexed color, returning its index. More...
 
A3DStatus A3DGlobalInsertGraphSolidPattern (const A3DGraphSolidPatternData *pData, A3DUns32 *puiIndexSolidPattern)
 Insert a new solid fill pattern into the global state, returning its index for further retrieval. More...
 
A3DStatus A3DGlobalInsertGraphStyle (const A3DGraphStyleData *pData, A3DUns32 *puiIndexStyle)
 Creates a new graphics style, returning its index. More...
 
A3DStatus A3DGlobalInsertGraphVPicturePattern (const A3DGraphVPicturePatternData *pData, A3DUns32 *puiIndexVPicturePattern)
 Insert a new vectorized picture fill pattern into the global state, returning its index for further retrieval. More...
 
A3DStatus A3DGraphAmbientLightCreate (const A3DGraphAmbientLightData *pData, A3DGraphAmbientLight **ppLight)
 Creates a new ambient light source entity, returning its handle. More...
 
A3DStatus A3DGraphAmbientLightGet (const A3DGraphAmbientLight *pLight, A3DGraphAmbientLightData *pData)
 Fetches data from an ambient light source entity given its handle. More...
 
A3DStatus A3DGraphCameraCreate (const A3DGraphCameraData *pData, A3DGraphCamera **ppCamera)
 Creates a new camera entity, returning its handle. More...
 
A3DStatus A3DGraphCameraGet (const A3DGraphCamera *pCamera, A3DGraphCameraData *pData)
 Fetches data from a camera entity given its handle. More...
 
A3DStatus A3DGraphDirectionalLightCreate (const A3DGraphDirectionalLightData *pData, A3DGraphDirectionalLight **ppLight)
 Creates a new directional source entity, returning its handle. More...
 
A3DStatus A3DGraphDirectionalLightGet (const A3DGraphDirectionalLight *pLight, A3DGraphDirectionalLightData *pData)
 Fetches data from a directional source entity given its handle. More...
 
A3DStatus A3DGraphicsCreate (const A3DGraphicsData *pData, A3DGraphics **ppGraphics)
 Creates a new graphics entity, returning its handle. More...
 
A3DStatus A3DGraphicsDelete (A3DGraphics *pGraphics)
 Deletes an A3DGraphics entity. More...
 
A3DStatus A3DGraphicsGet (const A3DGraphics *pGraphics, A3DGraphicsData *pData)
 Fetches data from a graphics entity, given its handle. More...
 
A3DStatus A3DGraphPointLightCreate (const A3DGraphPointLightData *pData, A3DGraphPointLight **ppLight)
 Creates a new point light source entity, returning its handle. More...
 
A3DStatus A3DGraphPointLightGet (const A3DGraphPointLight *pLight, A3DGraphPointLightData *pData)
 Fetches data from a point light source entity given its handle. More...
 
A3DStatus A3DGraphSceneDisplayParametersCreate (const A3DGraphSceneDisplayParametersData *pData, A3DGraphSceneDisplayParameters **ppSceneDisplayParameters)
 Creates a new A3DGraphSceneDisplayParameters entity, returning its handle. More...
 
A3DStatus A3DGraphSceneDisplayParametersGet (const A3DGraphSceneDisplayParameters *pSceneDisplayParameters, A3DGraphSceneDisplayParametersData *pData)
 Fetches data from a scene diplay parameters entity given its handle. More...
 
A3DStatus A3DGraphSpotLightCreate (const A3DGraphSpotLightData *pData, A3DGraphSpotLight **ppLight)
 Creates a new spotlight source entity, returning its handle. More...
 
A3DStatus A3DGraphSpotLightGet (const A3DGraphSpotLight *pLight, A3DGraphSpotLightData *pData)
 Fetches data from a spotlight source entity given its handle. More...
 
A3DStatus A3DMiscCascadedAttributesCreate (A3DMiscCascadedAttributes **ppAttr)
 Creates a new A3DMiscCascadedAttributes entity, returning its handle. More...
 
A3DStatus A3DMiscCascadedAttributesDelete (A3DMiscCascadedAttributes *pAttr)
 Deletes a A3DMiscCascadedAttributes. More...
 
A3DStatus A3DMiscCascadedAttributesGet (const A3DMiscCascadedAttributes *pAttr, A3DMiscCascadedAttributesData *psData)
 Fetches data from a cascaded attributes entity given its handle. More...
 
A3DStatus A3DMiscCascadedAttributesPush (A3DMiscCascadedAttributes *pAttr, const A3DRootBaseWithGraphics *pBase, const A3DMiscCascadedAttributes *pFather)
 Computes the result of cascaded attribute propagation from a parent node. More...
 
A3DStatus A3DMiscCascadedAttributesPushTessFace (A3DMiscCascadedAttributes *pAttr, const A3DRiRepresentationItem *pRepItem, const A3DTessBase *pTessBase, const A3DTessFaceData *psTessFaceData, A3DUns32 uiFaceIndex, const A3DMiscCascadedAttributes *pFather)
 Push a A3DMiscCascadedAttributesData for a A3DTessFaceData. More...
 
A3DStatus A3DMiscPointerFromIndexGet (const A3DUns32 uiIndex, const A3DEEntityType eType, A3DEntity **ppEntity)
 Retrieve the handle of an indexed entity. More...
 
A3DStatus A3DMiscRootBaseInsertAttribute (const A3DRootBase *pRootBase, const A3DMiscAttribute *pAttribute)
 Adds a new attribute to the given entity. More...
 

Detailed Description

Header file for the Graphics.

Author
Tech Soft 3D
Version
22.1
Date
April 2022
Copyright (c) 2010 - 2022 by Tech Soft 3D, Inc. All rights reserved.

Function Documentation

◆ A3DGlobalInsertGraphLinePattern()

A3DStatus A3DGlobalInsertGraphLinePattern ( const A3DGraphLinePatternData pData,
A3DUns32 puiIndexLinePattern 
)

Creates a line pattern, returning its index.

Version
2.0

When given an A3DGraphLinePatternData, the function searches for an already existing descriptor of the same value and returns its index. If the descriptor does not exist, it is created and a new index is returned. In case of failure *puiIndexRgbColor is unchanged.

A3DDouble[] aLengths = {1.0, 3.0};
descriptor.m_uiNumberOfLengths = 2;
descriptor.m_pdLengths = aLengths;
descriptor.m_dPhase = 0.0;
descriptor.m_bRealLength = A3D_TRUE;
A3DStatus result = A3DGlobalInsertGraphLinePattern(&descriptor, &idx_0);
assert(result == A3D_SUCCESS);
Second insertion with the same data, expect index to be the same.
result = A3DGlobalInsertGraphLinePattern(&descriptor, &idx_1);
assert(result == A3D_SUCCESS);
assert(idx_0 == idx_1);
Parameters
[in]pDataThe line pattern descriptor to insert.
[out]puiIndexLinePatternThe resulting index for the line pattern.
Returns
A3D_SUCCESS or an error code.
Return values
A3D_SUCCESSin case of success.
A3D_INITIALIZE_NOT_CALLEDif the library is not initialized.
A3D_INVALID_DATA_STRUCT_SIZEif pData is incorrectly initialized
A3D_INVALID_DATA_STRUCT_NULLif pData is null.

◆ A3DMiscCascadedAttributesPushTessFace()

A3DStatus A3DMiscCascadedAttributesPushTessFace ( A3DMiscCascadedAttributes pAttr,
const A3DRiRepresentationItem pRepItem,
const A3DTessBase pTessBase,
const A3DTessFaceData psTessFaceData,
A3DUns32  uiFaceIndex,
const A3DMiscCascadedAttributes pFather 
)

Push a A3DMiscCascadedAttributesData for a A3DTessFaceData.

Version
2.0
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_INITIALIZE_NOT_CALLED
A3D_INVALID_DATA_STRUCT_SIZE
A3D_INVALID_DATA_STRUCT_NULL
A3D_INVALID_ENTITY_NULL
A3D_INVALID_ENTITY_TYPE
A3D_SUCCESS