===========================
Tracer (hwx.inspire.motion)
===========================

A point in the model that traces out a path during Motion Runs

Inherits:
  - :ref:`MotionObject (hwx.inspire.motion)`

----------
Attributes
----------

  +---------------------+---------------------+---------------------+
  | active_: Bool       | color_: Color       | enableTrail_: Bool  |
  +---------------------+---------------------+---------------------+
  | location_: Location | name_: Attribute    | paper_: Attribute   |
  +---------------------+---------------------+---------------------+
  | parts_: Attribute   | pen_: Attribute     | thickness_: Int     |
  +---------------------+---------------------+---------------------+
  | trailFrames_: Int   | visible_: Bool      |                     |
  +---------------------+---------------------+---------------------+

--------------
Public Methods
--------------

  +-------------------------------------------------------------------------------------------+
  | classmethod showTraces_ (cls, analysis=True, frames=(0, None), ignoreTrails=True, **kwds) |
  +-------------------------------------------------------------------------------------------+
  | classmethod writeCsv_ (cls, tracers, file, analysis=None)                                 |
  +-------------------------------------------------------------------------------------------+
  | getDrawPoints_ (self, wrtPaper=True)                                                      |
  +-------------------------------------------------------------------------------------------+
  | getPoints_ (self, analysis, wrtPaper=False, startFrame=0)                                 |
  +-------------------------------------------------------------------------------------------+

-----------------
Attribute Details
-----------------

.. _active:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
active : :ref:`Bool <Bool (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Returns or sets the object activeness.

Setting this on or off sets all children.
Setting to True sets all the parents active too.

.. _color:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
color : :ref:`Color <Color (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^




.. _enableTrail:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
enableTrail : :ref:`Bool <Bool (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^




.. _location:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
location : :ref:`Location <Location (hwx.inspire)>` (units="length")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^




.. _name:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
name : :ref:`Attribute <Attribute (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Returns or sets the name of the object.

It can be any text string, including spaces, although it's best to avoid
using the following characters: " ' * ? and $.

While these characters are allowed, they could create difficulties when
you export the model to other applications.

.. _paper:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
paper : :ref:`Attribute <Attribute (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^




.. _parts:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
parts : :ref:`Attribute <Attribute (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^




.. _pen:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
pen : :ref:`Attribute <Attribute (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^




.. _thickness:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
thickness : :ref:`Int <Int (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^




.. _trailFrames:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
trailFrames : :ref:`Int <Int (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^




.. _visible:

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
visible : :ref:`Bool <Bool (hwx.inspire)>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Determines whether the object is visible in the graphics window.

Setting this on or off sets all children.
Setting to True sets all the parents visible too.


--------------
Method Details
--------------

.. _showTraces:
.. classmethod:: showTraces(cls, analysis=True, frames=(0, None), ignoreTrails=True, **kwds)

Show trace lines for all Tracers in the model. Limit what frames are
drawn by passing in (startFrame, endFrame).

.. _writeCsv:
.. classmethod:: writeCsv(cls, tracers, file, analysis=None)

Write points of all passed Tracers to a csv file

If multiple tracers are passed then the x, y, z column headers will have
the tracer's name prepended to them.

.. _getDrawPoints:
.. method:: getDrawPoints(self, wrtPaper=True)

Get points to draw if trace lines turned on

.. _getPoints:
.. method:: getPoints(self, analysis, wrtPaper=False, startFrame=0)

Get tracer location at every frame of the analysis

wrtPaper - transform points into paper parts reference frame