ENS_PROBE#
- class ansys.api.pyensight.ens_probe.ENS_PROBE(*args, **kwargs)#
This class acts as a proxy for the EnSight Python class ensight.objs.ENS_PROBE
- Args:
- *args:
Superclass (ENSOBJ) arguments
- **kwargs:
Superclass (ENSOBJ) keyword arguments
Methods
ENS_PROBE.attrgroupinfo
(*args, **kwargs)Get information about GUI groups for this probe's attributes
ENS_PROBE.attrinfo
([attrid])For a given attribute id, return type information
ENS_PROBE.attrissensitive
(attrid)Check to see if a given attribute is 'sensitive'
ENS_PROBE.attrtree
([all, filter, exclude, ...])Get detailed GUI information for attributes of this object.
Destroy the EnSight object associated with this proxy object
ENS_PROBE.getattr
(attrid)Query the value of the specified attribute
ENS_PROBE.getattrs
([attrid, text])Query the value of a collection of attributes
ENS_PROBE.getmetatag
(tag)Get the value of a tag in the METADATA attribute
ENS_PROBE.hasmetatag
(tag)Check to see if a tag exists in the METADATA attribute
ENS_PROBE.remove
(*args, **kwargs)Remove one probe
ENS_PROBE.setattr
(attrid, value)Set the value of the specified attribute
Signal bulk attribute update begin
Signal bulk attribute update end
ENS_PROBE.setattrs
(values[, all_errors])Set the values of a collection of attributes
ENS_PROBE.setmetatag
(tag, value)Change a value in the METADATA attribute
ENS_PROBE.surface_pick
(*args, **kwargs)Pick at given mouse position
Attributes
DESCRIPTION property
EDIT_TARGET property
Control the display and use of EnSight click and go handles for an object
LABELALWAYSONTOP property
LABELDECIMALPLACES property
LABELFORMAT property
LABELRGB property
LABELVISIBLE property
MARKERRGB property
MARKERSIZENORMALIZED property
MARKERVISIBLE property
METADATA property
NUMDISPLAYED property
PROBE_DATA property
PROJECT_MASK property
QUERY property
REQUESTMETHOD property
SEARCH property
UUID property
VARIABLES property
Return the EnSight object proxy ID (__OBJID__).