GeneralObject (hwx.inspire.core)

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.


active: Bool

name: Attribute

visible: Bool


Public Methods

getIcon (self)

requireRedraw (self)

Attribute Details

active : Bool

Returns or sets the object activeness.

Setting this on or off sets all children. Setting to True sets all the parents active too.

name : Attribute

Returns or sets the name of the object.

It can be any text string, including spaces, although it’s best to avoid using the following characters: ” ‘ * ? and $.

While these characters are allowed, they could create difficulties when you export the model to other applications.

visible : Bool

Determines whether the object is visible in the graphics window.

Setting this on or off sets all children. Setting to True sets all the parents visible too.

Property Details

property inbrowser

Show the object in the Model Browser.

property movable

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

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 ( == 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

Method Details


Specifies the icon used to display in Model Browser, Object Tables etc


Marks the object that needs to be redrawn in the graphics window.