ENS_TOOL

class ansys.api.pyensight.ens_tool.ENS_TOOL(*args, **kwargs)

This class acts as a proxy for the EnSight Python class ensight.objs.ENS_TOOL

Args:

*args:

Superclass (ENSOBJ) arguments

**kwargs:

Superclass (ENSOBJ) keyword arguments

Methods

ENS_TOOL.attrgroupinfo(*args, **kwargs)	Get information about GUI groups for this tool's attributes
ENS_TOOL.attrinfo([attrid])	For a given attribute id, return type information
ENS_TOOL.attrissensitive(attrid)	Check to see if a given attribute is 'sensitive'
ENS_TOOL.attrtree([all, filter, exclude, ...])	Get detailed GUI information for attributes of this object.
ENS_TOOL.destroy()	Destroy the EnSight object associated with this proxy object
ENS_TOOL.fit_to_selected(*args, **kwargs)	Set the box tool to span the selected parts
ENS_TOOL.getattr(attrid)	Query the value of the specified attribute
ENS_TOOL.getattrs([attrid, text])	Query the value of a collection of attributes
ENS_TOOL.getmetatag(tag)	Get the value of a tag in the METADATA attribute
ENS_TOOL.hasmetatag(tag)	Check to see if a tag exists in the METADATA attribute
ENS_TOOL.rawdata(*args, **kwargs)	Get/set the tool location using the raw location form
ENS_TOOL.setattr(attrid, value)	Set the value of the specified attribute
ENS_TOOL.setattr_begin()	Signal bulk attribute update begin
ENS_TOOL.setattr_end()	Signal bulk attribute update end
ENS_TOOL.setattr_status()
ENS_TOOL.setattrs(values[, all_errors])	Set the values of a collection of attributes
ENS_TOOL.setmetatag(tag, value)	Change a value in the METADATA attribute

Attributes

ENS_TOOL.CENTROID	CENTROID property
ENS_TOOL.CORE	CORE property
ENS_TOOL.DESCRIPTION	DESCRIPTION property
ENS_TOOL.EDIT_TARGET	EDIT_TARGET property
ENS_TOOL.HANDLES_ENABLED	Control the display and use of EnSight click and go handles for an object
ENS_TOOL.INDEX	INDEX property
ENS_TOOL.METADATA	METADATA property
ENS_TOOL.PROJECT_MASK	PROJECT_MASK property
ENS_TOOL.SELECTED	SELECTED property
ENS_TOOL.TOOLTYPE	TOOLTYPE property
ENS_TOOL.UUID	UUID property
ENS_TOOL.VISIBLE	VISIBLE property
ENS_TOOL.__OBJID__
ENS_TOOL.objid	Return the EnSight object proxy ID (__OBJID__).