GeneralObject (hwx.inspire.GeneralObject)#

class GeneralObject(self, **kwds)#

Bases: GeneralPhysical

GeneralObject class provides the ability to extend the Inspire data model with a custom entity.

This only enables the ability to create new named objects (like Joints, Forces, etc). It does not provide the ability to create your own Parts or Assemblies.

Attribute Table#
Name	Type
`defaultNamePrefix`	`str`
`folder`	`str`
`icon`	`str`
`inbrowser`	`property`
`movable`	`property`
`namespace`	`str`
`previousClassNames`	`list`
`redrawWhenUnitsChanged`	`property`
`singleton`	`bool`
`suppressible`	`property`

Method Table#
Name	Description
`getIcon` (self)	Specifies the icon used to display in Model Browser, Object Tables etc
`requireRedraw` (self)	Marks the object that needs to be redrawn in the graphics window.

property inbrowser: bool#: Show the object in the Model Browser.

property movable: bool#

Specifies if the object can be moved using the move tool.

If yes then getting/setting the object.position must be implemented.

Can be True, False or a subset of “TX TY TZ RX RY RZ”.

property redrawWhenUnitsChanged: bool#: Specifies whether the objects gets redrawn when gui units change.

property suppressible#

(bool) Show option to suppress object in the context menu.

Suppressed objects are deactivated (obj.active == False) so they don’t contribute to analyses.

The suppressed object will remain in the Model Browser (in a disabled state) so the user can unsuppress it.

Defaults to True

requireRedraw()#: Marks the object that needs to be redrawn in the graphics window.

getIcon()#: Specifies the icon used to display in Model Browser, Object Tables etc