.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXcg_unit_normal_set.nxdl.xml -- DO NOT EDIT

.. index::
    ! NXcg_unit_normal_set (base class)
    ! cg_unit_normal_set (base class)
    see: cg_unit_normal_set (base class); NXcg_unit_normal_set

.. _NXcg_unit_normal_set:

====================
NXcg_unit_normal_set
====================

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  .. collapse:: Computational geometry description of a set of (oriented) unit normal vectors. ...

      Computational geometry description of a set of (oriented) unit normal vectors.

      Store normal vector information as properties of primitives.
      Use only only as a child of an instance of :ref:`NXcg_primitive_set`
      so that this instance acts as the parent to define a context.

**Symbols**:

  The symbols used in the schema to specify e.g. dimensions of arrays.

  **d**: The dimensionality, which has to be at least 2.

  **c**: The cardinality of the set, i.e. the number of unit normals.

**Groups cited**:
  none

**Structure**:

  .. _/NXcg_unit_normal_set/normals-field:

  .. index:: normals (field)

  **normals**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 2, Dimensions: [c, d]) {units=\ :ref:`NX_LENGTH <NX_LENGTH>`} 

    Direction of each normal - a unit normal.

  .. _/NXcg_unit_normal_set/orientation-field:

  .. index:: orientation (field)

  **orientation**: (optional) :ref:`NX_INT <NX_INT>` (Rank: 1, Dimensions: [c]) {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`} 

    .. collapse:: Qualifier which details the orientation of each normal vector ...

        Qualifier which details the orientation of each normal vector
        in relation to its primitive, assuming the object is viewed
        from a position outside the object.

        * 0 - undefined
        * 1 - outer unit normal vector
        * 2 - inner unit normal vector


Hypertext Anchors
-----------------

List of hypertext anchors for all groups, fields,
attributes, and links defined in this class.


* :ref:`/NXcg_unit_normal_set/normals-field </NXcg_unit_normal_set/normals-field>`
* :ref:`/NXcg_unit_normal_set/orientation-field </NXcg_unit_normal_set/orientation-field>`

**NXDL Source**:
  https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXcg_unit_normal_set.nxdl.xml