ENS_TOOL_BOX#

class ansys.api.pyensight.ens_tool_box.ENS_TOOL_BOX(*args, **kwargs)#

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

Args:
*args:

Superclass (ENS_TOOL) arguments

**kwargs:

Superclass (ENS_TOOL) keyword arguments

Methods

ENS_TOOL_BOX.attrgroupinfo(*args, **kwargs)

Get information about GUI groups for this tool's attributes

ENS_TOOL_BOX.attrinfo([attrid])

For a given attribute id, return type information

ENS_TOOL_BOX.attrissensitive(attrid)

Check to see if a given attribute is 'sensitive'

ENS_TOOL_BOX.attrtree([all, filter, ...])

Get detailed GUI information for attributes of this object.

ENS_TOOL_BOX.destroy()

Destroy the EnSight object associated with this proxy object

ENS_TOOL_BOX.fit_to_selected(*args, **kwargs)

Set the box tool to span the selected parts

ENS_TOOL_BOX.getattr(attrid)

Query the value of the specified attribute

ENS_TOOL_BOX.getattrs([attrid, text])

Query the value of a collection of attributes

ENS_TOOL_BOX.getmetatag(tag)

Get the value of a tag in the METADATA attribute

ENS_TOOL_BOX.hasmetatag(tag)

Check to see if a tag exists in the METADATA attribute

ENS_TOOL_BOX.rawdata(*args, **kwargs)

Get/set the tool location using the raw location form

ENS_TOOL_BOX.setattr(attrid, value)

Set the value of the specified attribute

ENS_TOOL_BOX.setattr_begin()

Signal bulk attribute update begin

ENS_TOOL_BOX.setattr_end()

Signal bulk attribute update end

ENS_TOOL_BOX.setattr_status()

ENS_TOOL_BOX.setattrs(values[, all_errors])

Set the values of a collection of attributes

ENS_TOOL_BOX.setmetatag(tag, value)

Change a value in the METADATA attribute

Attributes

ENS_TOOL_BOX.CENTROID

CENTROID property

ENS_TOOL_BOX.CORE

CORE property

ENS_TOOL_BOX.DESCRIPTION

DESCRIPTION property

ENS_TOOL_BOX.EDIT_TARGET

EDIT_TARGET property

ENS_TOOL_BOX.HANDLES_ENABLED

Control the display and use of EnSight click and go handles for an object

ENS_TOOL_BOX.INDEX

INDEX property

ENS_TOOL_BOX.METADATA

METADATA property

ENS_TOOL_BOX.NORMAL

NORMAL property

ENS_TOOL_BOX.PROJECT_MASK

PROJECT_MASK property

ENS_TOOL_BOX.ROTATION

ROTATION property

ENS_TOOL_BOX.SELECTED

SELECTED property

ENS_TOOL_BOX.SIZE

SIZE property

ENS_TOOL_BOX.TOOLTYPE

TOOLTYPE property

ENS_TOOL_BOX.UUID

UUID property

ENS_TOOL_BOX.VISIBLE

VISIBLE property

ENS_TOOL_BOX.__OBJID__

ENS_TOOL_BOX.objid

Return the EnSight object proxy ID (__OBJID__).