.. role:: ts-api-decorator

###
Bcf
###

.. container:: ts-api-section

   .. js:module:: Bcf




.. toctree::
   :titlesonly:
   :hidden:

   /api_ref/viewing/interfaces/Bcf.ArgbColor
   /api_ref/viewing/classes/Bcf.BCFComment
   /api_ref/viewing/classes/Bcf.BCFData
   /api_ref/viewing/enum/Bcf.BCFFileType
   /api_ref/viewing/classes/Bcf.BCFMarkup
   /api_ref/viewing/classes/Bcf.BCFMarkupHeaderFile
   /api_ref/viewing/classes/Bcf.BCFMarkupViewpoint
   /api_ref/viewing/interfaces/Bcf.BcfNode
   /api_ref/viewing/classes/Bcf.BCFSnapshot
   /api_ref/viewing/classes/Bcf.BCFTopic
   /api_ref/viewing/enum/Bcf.BCFVersion
   /api_ref/viewing/classes/Bcf.BCFViewpoint
   /api_ref/viewing/interfaces/Bcf.ClippingPlane
   /api_ref/viewing/interfaces/Bcf.Component
   /api_ref/viewing/interfaces/Bcf.Line
   /api_ref/viewing/interfaces/Bcf.MarkupBimSnippet
   /api_ref/viewing/interfaces/Bcf.MarkupDocumentReference
   /api_ref/viewing/interfaces/Bcf.MarkupRelatedTopic
   /api_ref/viewing/interfaces/Bcf.MarkupTopic
   /api_ref/viewing/interfaces/Bcf.OrthogonalCamera
   /api_ref/viewing/interfaces/Bcf.PerspectiveCamera
   /api_ref/viewing/interfaces/Bcf.ViewpointComponents
   /api_ref/viewing/interfaces/Bcf.ViewSetupHints

.. container:: api-index-section

   .. rubric:: Enumerations

   .. rst-class:: api-index-list-item api-kind-enum api-parent-kind-namespace

   * :ref:`Bcf.BCFFileType`
   * :ref:`Bcf.BCFVersion`



.. container:: api-index-section

   .. rubric:: Classes

   .. rst-class:: api-index-list-item api-kind-class api-parent-kind-namespace

   * :js:class:`~Bcf.BCFComment`
   * :js:class:`~Bcf.BCFData`
   * :js:class:`~Bcf.BCFMarkup`
   * :js:class:`~Bcf.BCFMarkupHeaderFile`
   * :js:class:`~Bcf.BCFMarkupViewpoint`
   * :js:class:`~Bcf.BCFSnapshot`
   * :js:class:`~Bcf.BCFTopic`
   * :js:class:`~Bcf.BCFViewpoint`



.. container:: api-index-section

   .. rubric:: Interfaces

   .. rst-class:: api-index-list-item api-kind-interface api-parent-kind-namespace

   * :js:class:`~Bcf.ArgbColor`
   * :js:class:`~Bcf.BcfNode`
   * :js:class:`~Bcf.ClippingPlane`
   * :js:class:`~Bcf.Component`
   * :js:class:`~Bcf.Line`
   * :js:class:`~Bcf.MarkupBimSnippet`
   * :js:class:`~Bcf.MarkupDocumentReference`
   * :js:class:`~Bcf.MarkupRelatedTopic`
   * :js:class:`~Bcf.MarkupTopic`
   * :js:class:`~Bcf.OrthogonalCamera`
   * :js:class:`~Bcf.PerspectiveCamera`
   * :js:class:`~Bcf.ViewSetupHints`
   * :js:class:`~Bcf.ViewpointComponents`



.. container:: api-index-section

   .. rubric:: Type Aliases

   .. rst-class:: api-index-list-item api-kind-typealias api-parent-kind-namespace

   * :ref:`Bcf.BCFCommentId`
   * :ref:`Bcf.BCFMarkupName`
   * :ref:`Bcf.BCFName`
   * :ref:`Bcf.BCFTopicId`
   * :ref:`Bcf.BCFViewpointName`



.. container:: api-index-section

   .. rubric:: Variables

   .. rst-class:: api-index-list-item api-kind-variable api-parent-kind-namespace

   * :js:data:`~Bcf.defaultOriginatingSystem`



.. container:: api-index-section

   .. rubric:: Functions

   .. rst-class:: api-index-list-item api-kind-function api-parent-kind-namespace

   * :js:func:`~Bcf.addElem`
   * :js:func:`~Bcf.appendPoint3`
   * :js:func:`~Bcf.argbStringFromColor`
   * :js:func:`~Bcf.boolToString`
   * :js:func:`~Bcf.conditionalAddElem`
   * :js:func:`~Bcf.conditionalBoolToString`
   * :js:func:`~Bcf.conditionalDateToString`
   * :js:func:`~Bcf.conditionalNumberToString`
   * :js:func:`~Bcf.conditionalSetAttribute`
   * :js:func:`~Bcf.exportComponent`





------------

Type Aliases
============

.. rst-class:: ts-api-section

.. _Bcf.BCFCommentId:

BCFCommentId
------------

.. rst-class:: ts-api-section

.. _Bcf.BCFMarkupName:

BCFMarkupName
-------------

.. rst-class:: ts-api-section

.. _Bcf.BCFName:

BCFName
-------

.. rst-class:: ts-api-section

.. _Bcf.BCFTopicId:

BCFTopicId
----------

.. rst-class:: ts-api-section

.. _Bcf.BCFViewpointName:

BCFViewpointName
----------------

Variables
=========

.. container:: ts-api-section

   .. js:data:: Bcf.defaultOriginatingSystem

      :type: HOOPS Communicator





Functions
=========

.. rst-class:: ts-api-section

addElem
-------

.. js:function:: addElem( doc, parentElem, elementName, elementContent)

   :param doc: None
   :type doc: XMLDocument
   :param parentElem: None
   :type parentElem: HTMLElement
   :param elementName: None
   :type elementName: string
   :param elementContent: None
   :type elementContent: string


   :rtype: void

.. rst-class:: ts-api-section

appendPoint3
------------

.. js:function:: appendPoint3( doc, elem, p)

   :param doc: None
   :type doc: XMLDocument
   :param elem: None
   :type elem: HTMLElement
   :param p: None
   :type p: Point3


   :rtype: void

.. rst-class:: ts-api-section

argbStringFromColor
-------------------

.. js:function:: argbStringFromColor( color, alpha)

   :param color: None
   :type color: Color
   :param alpha: None
   :type alpha: undefined | number


   :rtype: string

.. rst-class:: ts-api-section

boolToString
------------

.. js:function:: boolToString( b)

   :param b: None
   :type b: boolean


   :rtype: string

.. rst-class:: ts-api-section

conditionalAddElem
------------------

.. js:function:: conditionalAddElem( doc, parentElem, elementName, elementContent)

   :param doc: None
   :type doc: XMLDocument
   :param parentElem: None
   :type parentElem: HTMLElement
   :param elementName: None
   :type elementName: string
   :param elementContent: None
   :type elementContent: undefined | null | string


   :rtype: void

.. rst-class:: ts-api-section

conditionalBoolToString
-----------------------

.. js:function:: conditionalBoolToString( b)

   :param b: None
   :type b: undefined | null | boolean


   :rtype: string | null

.. rst-class:: ts-api-section

conditionalDateToString
-----------------------

.. js:function:: conditionalDateToString( d)

   :param d: None
   :type d: undefined | null | Date


   :rtype: string | null

.. rst-class:: ts-api-section

conditionalNumberToString
-------------------------

.. js:function:: conditionalNumberToString( n)

   :param n: None
   :type n: undefined | null | number


   :rtype: string | null

.. rst-class:: ts-api-section

conditionalSetAttribute
-----------------------

.. js:function:: conditionalSetAttribute( elem, attrName, attrVal)

   :param elem: None
   :type elem: HTMLElement
   :param attrName: None
   :type attrName: string
   :param attrVal: None
   :type attrVal: undefined | null | string


   :rtype: void

.. rst-class:: ts-api-section

exportComponent
---------------

.. js:function:: exportComponent( doc, component)

   :param doc: None
   :type doc: XMLDocument
   :param component: None
   :type component: Component


   :rtype: HTMLElement

