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

.. index::
    ! NXcsg (base class)
    ! csg (base class)
    see: csg (base class); NXcsg

.. _NXcsg:

=====
NXcsg
=====

..
    Contributors List

    .. |contrib_name| replace:: Pete R Jemian|prjemian|https://avatars.githubusercontent.com/u/2279984?v=4|2022-03-08

    .. |contrib_name| replace:: Tobias Richter|zjttoefs|https://avatars.githubusercontent.com/u/856440?v=4|2018-10-24

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  Constructive Solid Geometry base class, using :ref:`NXquadric` and :ref:`NXoff_geometry`

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXcsg`

.. index:: NXcsg (base class); used in base class

**Structure**:

  .. _/NXcsg/operation-field:

  .. index:: operation (field)

  **operation**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

    .. collapse:: One of the standard construction solid geometry set operations, ...

        One of the standard construction solid geometry set operations,
        or if the CSG is a pointer to the geometry provided by an
        :ref:`NXquadric` or an :ref:`NXoff_geometry`. Takes values:

        Any of these values:

          * ``UNION``

          * ``INTERSECTION``

          * ``DIFFERENCE``

          * ``COMPLEMENT``

          * ``IS_QUADRIC``

          * ``IS_MESH``


  .. _/NXcsg/geometry-field:

  .. index:: geometry (field)

  **geometry**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

    .. collapse:: Path to a field that is either an :ref:`NXquadric` (if ...

        Path to a field that is either an :ref:`NXquadric` (if
        'operation' = IS_QUADRIC) or an :ref:`NXoff_geometry` (if
        'operation' = IS_MESH) that defines the surface making up the
        constructive solid geometry component. Compulsory if 'operation'
        is IS_QUADRIC or IS_MESH.

  .. _/NXcsg/a-group:

  **a**: (optional) :ref:`NXcsg` 

    .. collapse:: The first operand of constructive solid geometry ...

        The first operand of constructive solid geometry
        operation. Compulsory if 'operation' is UNION, INTERSECTION,
        DIFFERENCE or COMPLEMENT.

  .. _/NXcsg/b-group:

  **b**: (optional) :ref:`NXcsg` 

    .. collapse:: The second operand of constructive solid geometry ...

        The second operand of constructive solid geometry
        operation. Compulsory if 'operation' is UNION, INTERSECTION or
        DIFFERENCE.


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

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


* :ref:`/NXcsg/a-group </NXcsg/a-group>`
* :ref:`/NXcsg/b-group </NXcsg/b-group>`
* :ref:`/NXcsg/geometry-field </NXcsg/geometry-field>`
* :ref:`/NXcsg/operation-field </NXcsg/operation-field>`

**NXDL Source**:
  https://github.com/nexusformat/definitions/blob/main/contributed_definitions/NXcsg.nxdl.xml