Object API reference

The “object” 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 “native” API, there are some operations that can only be performed via that interface.

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