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.
ENS_PROBE.destroy()	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
ENS_PROBE.setattr_begin()	Signal bulk attribute update begin
ENS_PROBE.setattr_end()	Signal bulk attribute update end
ENS_PROBE.setattr_status()
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

ENS_PROBE.DESCRIPTION	DESCRIPTION property
ENS_PROBE.EDIT_TARGET	EDIT_TARGET property
ENS_PROBE.HANDLES_ENABLED	Control the display and use of EnSight click and go handles for an object
ENS_PROBE.LABELALWAYSONTOP	LABELALWAYSONTOP property
ENS_PROBE.LABELDECIMALPLACES	LABELDECIMALPLACES property
ENS_PROBE.LABELFORMAT	LABELFORMAT property
ENS_PROBE.LABELRGB	LABELRGB property
ENS_PROBE.LABELVISIBLE	LABELVISIBLE property
ENS_PROBE.MARKERRGB	MARKERRGB property
ENS_PROBE.MARKERSIZENORMALIZED	MARKERSIZENORMALIZED property
ENS_PROBE.MARKERVISIBLE	MARKERVISIBLE property
ENS_PROBE.METADATA	METADATA property
ENS_PROBE.NUMDISPLAYED	NUMDISPLAYED property
ENS_PROBE.PROBE_DATA	PROBE_DATA property
ENS_PROBE.PROJECT_MASK	PROJECT_MASK property
ENS_PROBE.QUERY	QUERY property
ENS_PROBE.REQUESTMETHOD	REQUESTMETHOD property
ENS_PROBE.SEARCH	SEARCH property
ENS_PROBE.UUID	UUID property
ENS_PROBE.VARIABLES	VARIABLES property
ENS_PROBE.__OBJID__
ENS_PROBE.objid	Return the EnSight object proxy ID (__OBJID__).