.. _group__a3d__00__library__core:

########
API Core
########

Foundational SDK plumbing.

This topic covers the plumbing beneath every other capability: starting, configuring, and terminating a session with the library, the base entity and generic-type system shared by every PRC entity, the entities referenceable from other entities, and global-data access. License management, custom memory-allocation, message reporting, and API tracing are documented on their functions directly in this group.


Referenceable Entities
======================

The following non-topological entities can be referenced from an :c:type:`~A3DMiscEntityReference` entity:


- :c:enumerator:`~kA3DTypeMiscEntityReference` 
- :c:enumerator:`~kA3DTypeMiscMarkupLinkedItem`


- :c:enumerator:`~kA3DTypeRiBrepModel` 
- :c:enumerator:`~kA3DTypeRiCurve` 
- :c:enumerator:`~kA3DTypeRiDirection` 
- :c:enumerator:`~kA3DTypeRiPlane` 
- :c:enumerator:`~kA3DTypeRiPointSet` 
- :c:enumerator:`~kA3DTypeRiPolyBrepModel` 
- :c:enumerator:`~kA3DTypeRiPolyWire` 
- :c:enumerator:`~kA3DTypeRiSet` 
- :c:enumerator:`~kA3DTypeRiCoordinateSystem`


- :c:enumerator:`~kA3DTypeAsmProductOccurrence` 
- :c:enumerator:`~kA3DTypeAsmPartDefinition` 
- :c:enumerator:`~kA3DTypeAsmFilter`


- :c:enumerator:`~kA3DTypeMkpView` 
- :c:enumerator:`~kA3DTypeMkpMarkup` 
- :c:enumerator:`~kA3DTypeMkpLeader` 
- :c:enumerator:`~kA3DTypeMkpAnnotationItem` 
- :c:enumerator:`~kA3DTypeMkpAnnotationSet` 
- :c:enumerator:`~kA3DTypeMkpAnnotationReference`


- :c:enumerator:`~kA3DTypeGraphStyle` 
- :c:enumerator:`~kA3DTypeGraphMaterial` 
- :c:enumerator:`~kA3DTypeGraphTextureApplication` 
- :c:enumerator:`~kA3DTypeGraphTextureDefinition` 
- :c:enumerator:`~kA3DTypeGraphTextureTransformation` 
- :c:enumerator:`~kA3DTypeGraphLinePattern` 
- :c:enumerator:`~kA3DTypeGraphDottingPattern` 
- :c:enumerator:`~kA3DTypeGraphHatchingPattern` 
- :c:enumerator:`~kA3DTypeGraphSolidPattern` 
- :c:enumerator:`~kA3DTypeGraphVPicturePattern` 
- :c:enumerator:`~kA3DTypeGraphCamera` 
- :c:enumerator:`~kA3DTypeGraphAmbientLight` 
- :c:enumerator:`~kA3DTypeGraphPointLight` 
- :c:enumerator:`~kA3DTypeGraphDirectionalLight` 
- :c:enumerator:`~kA3DTypeGraphSpotLight` 
- :c:enumerator:`~kA3DTypeGraphCamera`

\ The following topological entities can be referenced from an :c:type:`~A3DMiscReferenceOnTopology` entity:


- :c:enumerator:`~kA3DTypeTopoMultipleVertex` 
- :c:enumerator:`~kA3DTypeTopoUniqueVertex` 
- :c:enumerator:`~kA3DTypeTopoWireEdge` 
- :c:enumerator:`~kA3DTypeTopoEdge` 
- :c:enumerator:`~kA3DTypeTopoLoop` 
- :c:enumerator:`~kA3DTypeTopoFace` 
- :c:enumerator:`~kA3DTypeTopoShell` 
- :c:enumerator:`~kA3DTypeTopoConnex`

\ Currently, not all topological entities are supported. See :c:type:`~A3DMiscReferenceOnTopology` for limitations.



Root Entities
=============

This section describes the root entity attributes that apply to all PRC entities or to all PRC entities in the :ref:`Graphics and Appearance <group__a3d__40__graphics>`\ .

All PRC entities declared by HOOPS Exchange are of type :c:type:`~A3DEntity`\ . All :c:type:`~A3DEntity` entities inherit the :c:type:`~A3DRootBase` entity, which can include text names that provide modeller data and other data about the more specific form of the PRC entities.

PRC entities in the :ref:`Graphics Type Declarations <group__a3d__graphics__types>` also inherit the :c:type:`~A3DRootBaseWithGraphics` entity. The :c:type:`~A3DRootBaseWithGraphics` entity has attributes that reference graphics data stored in :c:type:`~A3DGlobal` PRC entities and that specify inheritance behaviour.


.. rst-class:: kind-group kind-topic

.. rubric:: Topics
   :class: kind-group-title


.. rst-class:: api-xref-list


* :ref:`Base Module <group__a3d__base__module>`
* :ref:`Debug Utilities <group__a3d__error__debug__utilities>`
* :ref:`Delete Entities <group__a3d__entity__delete>`
* :ref:`Entity Base <group__a3d__rootbase>`
* :ref:`Entity Base with Graphics <group__a3d__rootbasewithgraphics>`
* :ref:`Entity Reference <group__a3d__entity__reference>`
* :ref:`Entity Type Determination <group__a3d__entitytype__functions>`
* :ref:`Fundamental Type Definitions <group__a3d__fundamental__types>`
* :ref:`Miscellaneous Module <group__a3d__misc__module>`
* :ref:`Reference on coordinate system subcomponent <group__a3d__reference__on__csys__sub__cmpnt>`
* :ref:`Reference on Topology/Tessellation <group__a3d__reference__on__topo>`
* :ref:`UTF-8 Conversion Utilities <group__a3d___u_t_f8__utilities>`
* :ref:`XML Trace File Generation <group__a3d__debug__functions>`

.. toctree::
   :maxdepth: 1
   :hidden:

   a3d_base_module
   a3d_debug_functions
   a3d_misc_module
   a3d_entity_reference
   a3d_reference_on_topo
   a3d_reference_on_csys_sub_cmpnt
   a3d_UTF8_utilities
   a3d_error_debug_utilities
   a3d_entitytype_functions
   a3d_rootbase
   a3d_rootbasewithgraphics
   a3d_entity_delete
   a3d_fundamental_types


