.. _ref_object_api_docs:

********************
Object API reference
********************

The :ref:`"object"<ref_object_api>` API is a direct interface to the EnSight object structures.
It includes the ability to set/query attributes as well as connect callback
function that execute when attribute values change, etc. While it is a more
advanced interface than the :ref:`"native"<ref_cmdlang_native>`  API, there are some
operations that can only be performed via that interface.


.. toctree::
   :hidden:
   :maxdepth: 4


.. autosummary::
   :toctree: _autosummary/

   ansys.pyensight.core.ensobj.ENSOBJ
   ansys.pyensight.core.ensobjlist
   ansys.api.pyensight.calc_funcs.ens_calculator
   ansys.api.pyensight.ens_annot.ENS_ANNOT
   ansys.api.pyensight.ens_annot_text.ENS_ANNOT_TEXT
   ansys.api.pyensight.ens_annot_line.ENS_ANNOT_LINE
   ansys.api.pyensight.ens_annot_logo.ENS_ANNOT_LOGO
   ansys.api.pyensight.ens_annot_lgnd.ENS_ANNOT_LGND
   ansys.api.pyensight.ens_annot_marker.ENS_ANNOT_MARKER
   ansys.api.pyensight.ens_annot_arrow.ENS_ANNOT_ARROW
   ansys.api.pyensight.ens_annot_dial.ENS_ANNOT_DIAL
   ansys.api.pyensight.ens_annot_gauge.ENS_ANNOT_GAUGE
   ansys.api.pyensight.ens_annot_shape.ENS_ANNOT_SHAPE
   ansys.api.pyensight.ens_camera.ENS_CAMERA
   ansys.api.pyensight.ens_case.ENS_CASE
   ansys.api.pyensight.ens_flipbook.ENS_FLIPBOOK
   ansys.api.pyensight.ens_frame.ENS_FRAME
   ansys.api.pyensight.ens_geom.ENS_GEOM
   ansys.api.pyensight.ens_globals.ENS_GLOBALS
   ansys.api.pyensight.ens_group.ENS_GROUP
   ansys.api.pyensight.ens_lightsource.ENS_LIGHTSOURCE
   ansys.api.pyensight.ens_lpart.ENS_LPART
   ansys.api.pyensight.ens_mat.ENS_MAT
   ansys.api.pyensight.ens_palette.ENS_PALETTE
   ansys.api.pyensight.ens_part.ENS_PART
   ansys.api.pyensight.ens_part_model.ENS_PART_MODEL
   ansys.api.pyensight.ens_part_clip.ENS_PART_CLIP
   ansys.api.pyensight.ens_part_contour.ENS_PART_CONTOUR
   ansys.api.pyensight.ens_part_discrete_particle.ENS_PART_DISCRETE_PARTICLE
   ansys.api.pyensight.ens_part_frame.ENS_PART_FRAME
   ansys.api.pyensight.ens_part_isosurface.ENS_PART_ISOSURFACE
   ansys.api.pyensight.ens_part_particle_trace.ENS_PART_PARTICLE_TRACE
   ansys.api.pyensight.ens_part_profile.ENS_PART_PROFILE
   ansys.api.pyensight.ens_part_vector_arrow.ENS_PART_VECTOR_ARROW
   ansys.api.pyensight.ens_part_elevated_surface.ENS_PART_ELEVATED_SURFACE
   ansys.api.pyensight.ens_part_developed_surface.ENS_PART_DEVELOPED_SURFACE
   ansys.api.pyensight.ens_part_built_up.ENS_PART_BUILT_UP
   ansys.api.pyensight.ens_part_tensor_glyph.ENS_PART_TENSOR_GLYPH
   ansys.api.pyensight.ens_part_fx_vortex_core.ENS_PART_FX_VORTEX_CORE
   ansys.api.pyensight.ens_part_fx_shock.ENS_PART_FX_SHOCK
   ansys.api.pyensight.ens_part_fx_sep_att.ENS_PART_FX_SEP_ATT
   ansys.api.pyensight.ens_part_mat_interface.ENS_PART_MAT_INTERFACE
   ansys.api.pyensight.ens_part_point.ENS_PART_POINT
   ansys.api.pyensight.ens_part_axisymmetric.ENS_PART_AXISYMMETRIC
   ansys.api.pyensight.ens_part_vof.ENS_PART_VOF
   ansys.api.pyensight.ens_part_aux_geom.ENS_PART_AUX_GEOM
   ansys.api.pyensight.ens_part_filter.ENS_PART_FILTER
   ansys.api.pyensight.ens_plotter.ENS_PLOTTER
   ansys.api.pyensight.ens_polyline.ENS_POLYLINE
   ansys.api.pyensight.ens_probe.ENS_PROBE
   ansys.api.pyensight.ens_query.ENS_QUERY
   ansys.api.pyensight.ens_scene.ENS_SCENE
   ansys.api.pyensight.ens_source.ENS_SOURCE
   ansys.api.pyensight.ens_spec.ENS_SPEC
   ansys.api.pyensight.ens_state.ENS_STATE
   ansys.api.pyensight.ens_texture.ENS_TEXTURE
   ansys.api.pyensight.ens_tool.ENS_TOOL
   ansys.api.pyensight.ens_tool_cursor.ENS_TOOL_CURSOR
   ansys.api.pyensight.ens_tool_line.ENS_TOOL_LINE
   ansys.api.pyensight.ens_tool_plane.ENS_TOOL_PLANE
   ansys.api.pyensight.ens_tool_box.ENS_TOOL_BOX
   ansys.api.pyensight.ens_tool_cylinder.ENS_TOOL_CYLINDER
   ansys.api.pyensight.ens_tool_cone.ENS_TOOL_CONE
   ansys.api.pyensight.ens_tool_sphere.ENS_TOOL_SPHERE
   ansys.api.pyensight.ens_tool_revolution.ENS_TOOL_REVOLUTION
   ansys.api.pyensight.ens_var.ENS_VAR
   ansys.api.pyensight.ens_vport.ENS_VPORT