Graphics

group a3d_graphics_module

Query and manipulate scene and rendering informations.

The graphics group provides the essential set of tools for describing a rendering scene, such as texturing, lighting or view information. The following entities are presents in this modules, along with their public data and access functions:

The module also provides a set of indexed data:

Any entity of the given type can be used as an A3DRootBaseWithGraphics.

General Structure

An entity of type A3DRootBaseWithGraphics embeds an A3DGraphics entity. This structure mainly provides two informations:

A layer which allows grouping entities with a common identifier.
A style index which references an A3DGraphStyleData. A3DGraphStyleData lists all graphics properties the A3DRootBaseWithGraphics is assigned to, such as drawing patterns, materials or textures.

HOOPS Exchange provides a global container (A3DGlobalData) which references each of these data using indexed lists. Thus, structures such as A3DGraphRgbColorData are obtained using an non-typed numerical index.

Indexed data: Indexed data are plain structures which are globally shared among a potentially important amount of entities within a model file. For example, the same color description can be used for all the graphics entities of a scene.

Yet, these data act as front-end for internal entities which are still referenced to by handles. The purpose of obtaining the underlying entity of an indexed data depends on the context and is generally an uncommon operation. As an example, the full PBR (Physically-Based Rendering) features is provided as an extension of A3DGraphMaterialData throughout its underlying entity. To retrieve the underlying entity of an indexed data, see A3DMiscPointerFromIndexGet.

Data Structures

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

Functions

`A3DGraphicsGet()`	Fetches data from a graphics entity, given its handle.
`A3DGraphicsCreate()`	Creates a new graphics entity, returning its handle.
`A3DGraphicsDelete()`	Deletes an A3DGraphics entity.
`A3DGlobalGetGraphStyleData()`	Retrieves an indexed graph style.
`A3DGlobalInsertGraphStyle()`	Creates a new graphics style, returning its index.
`A3DGlobalGetGraphRgbColorData()`	Retrieves an indexed RGB color.
`A3DGlobalInsertGraphRgbColor()`	Creates a new indexed color, returning its index.
`A3DGlobalGetGraphLinePatternData()`	Retrieves a line pattern descriptor.
`A3DGlobalGetGraphMaterialData()`	Retrieves an indexed RGB color.
`A3DGlobalInsertGraphMaterial()`	Creates a new material, returning its index.
`A3DGlobalGetGraphPictureData()`	Retrieves an A3DGraphPictureData instance.
`A3DGlobalInsertGraphPicture()`	Insert a new picture into the global state, returning its index.
`A3DGlobalGetGraphDottingPatternData()`	Retrieves an A3DGraphDottingPatternData instance.
`A3DGlobalInsertGraphDottingPattern()`	Insert a new dotting pattern into the global state, returning its index.
`A3DGlobalGetGraphHatchingPatternData()`	Retrieves an A3DGraphHatchingPatternData instance.
`A3DGlobalInsertGraphHatchingPattern()`	Insert a new hatching lines fill pattern into the global state, returning its index for further retrieval.
`A3DGlobalGetGraphSolidPatternData()`	Retrieves an A3DGraphHatchingPatternData instance.
`A3DGlobalInsertGraphSolidPattern()`	Insert a new solid fill pattern into the global state, returning its index for further retrieval.
`A3DGlobalGetGraphVPicturePatternData()`	Retrieves an A3DGraphVPicturePatternData instance.
`A3DGlobalInsertGraphVPicturePattern()`	Insert a new vectorized picture fill pattern into the global state, returning its index for further retrieval.
`A3DGraphCameraGet()`	Fetches data from a camera entity given its handle.
`A3DGraphCameraCreate()`	Creates a new camera entity, returning its handle.
`A3DGraphAmbientLightGet()`	Fetches data from an ambient light source entity given its handle.
`A3DGraphAmbientLightCreate()`	Creates a new ambient light source entity, returning its handle.
`A3DGraphPointLightGet()`	Fetches data from a point light source entity given its handle.
`A3DGraphPointLightCreate()`	Creates a new point light source entity, returning its handle.
`A3DGraphSpotLightGet()`	Fetches data from a spotlight source entity given its handle.
`A3DGraphSpotLightCreate()`	Creates a new spotlight source entity, returning its handle.
`A3DGraphDirectionalLightGet()`	Fetches data from a directional source entity given its handle.
`A3DGraphDirectionalLightCreate()`	Creates a new directional source entity, returning its handle.
`A3DGraphSceneDisplayParametersGet()`	Fetches data from a scene diplay parameters entity given its handle.
`A3DGraphSceneDisplayParametersCreate()`	Creates a new A3DGraphSceneDisplayParameters entity, returning its handle.
`A3DMiscCascadedAttributesCreate()`	Creates a new A3DMiscCascadedAttributes entity, returning its handle.
`A3DMiscCascadedAttributesDelete()`	Deletes a A3DMiscCascadedAttributes .
`A3DMiscCascadedAttributesGet()`	Fetches data from a cascaded attributes entity given its handle.
`A3DMiscCascadedAttributesPush()`	Computes the result of cascaded attribute propagation from a parent node.
`A3DMiscPointerFromIndexGet()`	Retrieve the handle of an indexed entity.
`A3DMiscRootBaseInsertAttribute()`	Adds a new attribute to the given entity.