Interface Info

class lwsdk.LWInterfaceInfo(*args)

Bases: object

Proxy of C++ PCore::LWInterfaceInfo class

 alertLevel → int

The alert level for information dialogs. This affects how the information is displayed. Possible values are:

lwsdk.LWALERT_BEGINNER
lwsdk.LWALERT_INTERMEDIATE
lwsdk.LWALERT_EXPERT

 autoKeyCreate → int

The auto key create mode state, defined as one of these values:

lwsdk.LWAKC_OFF
lwsdk.LWAKC_MODIFIED
lwsdk.LWAKC_ALL
lwsdk.LWAKC_EXISTING

 boxThreshold → int

The bounding box threshold. Objects with a number of points greater than this threshold are drawn initially as bounding boxes to speed up interaction.

 curTime → LWTime

The current animation time selected in the Layout interface.

 displayFlags → unsigned int

Contains the state of certain display options as bit fields combined using bitwise-or. When set, a bit indicates that the corresponding option is turned on for the display.

lwsdk.LWDISPF_MOTIONPATHS
lwsdk.LWDISPF_HANDLES
lwsdk.LWDISPF_IKCHAINS
lwsdk.LWDISPF_CAGES
lwsdk.LWDISPF_SAFEAREAS
lwsdk.LWDISPF_FIELDCHART

 dynaUpdate → int

Contains the current state of Layout's Dynamic Update setting, which controls how frequently the interface is updated while the user makes changes. Possible values are:

lwsdk.LWDYNUP_OFF
lwsdk.LWDYNUP_DELAYED
lwsdk.LWDYNUP_INTERACTIVE

 generalFlags → unsigned int

Contains the state of certain interface options as bit fields combined using bitwise-or. When set, a bit indicates that the corresponding option is turned on for the interface.

  lwsdk.LWGENF_HIDETOOLBAR
  lwsdk.LWGENF_RIGHTTOOLBAR
  lwsdk.LWGENF_PARENTINPLACE
  lwsdk.LWGENF_FRACTIONALFRAME
  lwsdk.LWGENF_KEYSINSLIDER
  lwsdk.LWGENF_PLAYEXACTRATE
  lwsdk.LWGENF_AUTOKEY (LW7.5+)
  lwsdk.LWGENF_IKENABLE (rev.4+)
    This indicates that IK (Inverse Kinematics) is enabled.
  lwsdk.LWGENF_LMBITEMSELECT
  lwsdk.LWGENF_DOUBLECLICKBONEMODE
    On when switching between bones and non-bones requires a double mouse click.
  lwsdk.LWGENF_MCENABLE
    Set when the use of motion controllers (other than IK) is enabled.

 get_default_item_type_color(LWItemType itemtype) → color[3]

This is a Python helper method that should be used to retrieve the floating-point color of the default item type color for the specified itemtype.

 itemColor(LWItemID item) → int

Returns an index into the list of colors used to draw an item's wireframe.

 itemColorRgba(LWItemID item, unsigned int state) → color[3]

Returns the interface color of the item in the given state as floating point RGBA values. This takes into account if the item is selected or not, and if a custom color is used. The state is one if:

  lwsdk.LWITEMCOL_CURRENT
    The color of the item in its current state
  lwsdk.LWITEMCOL_NORMAL
    The color of the item in normal (non-selected) state
  lwsdk.LWITEMCOL_SELECTED
    The color of the item in selected state

 itemFlags(LWItemID item) → unsigned int

Returns a set of bit flags for the item. These can be any combination of the following:

lwsdk.LWITEMF_SELECTED
lwsdk.LWITEMF_SHOWCHILDREN
lwsdk.LWITEMF_SHOWCHANNELS
lwsdk.LWITEMF_LOCKED

 itemIconScale(LWItemID item) → float

Returns the icon scale of the item. This is used to size the icon representation of the item in the viewports.

 itemVis(LWItemID item) → int

Returns a code describing how an item is drawn in the interface. For objects, this can be one of the following:

lwsdk.LWOVIS_HIDDEN
lwsdk.LWOVIS_BOUNDINGBOX
lwsdk.LWOVIS_VERTICES
lwsdk.LWOVIS_WIREFRAME
lwsdk.LWOVIS_FFWIREFRAME
lwsdk.LWOVIS_SHADED
lwsdk.LWOVIS_TEXTURED
lwsdk.LWOVIS_TEXTURED_WIRE
    This is the textured wire mode with combines the textured and front face wire-frame draw modes.

Other item types are limited to lwsdk.LWIVIS_HIDDEN and lwsdk.LWIVIS_VISIBLE.

 previewEnd → LWFrame

The end of the range used by the frame slider and by Layout previews. This differs from the end range for rendering, which are returned by the Scene Info global.

 previewStart → LWFrame

The start of the range used by the frame slider and by Layout previews. This differs from the start range for rendering, which are returned by the Scene Info global.

 previewStep → LWFrame

The step value used by the frame slider and by Layout previews. This differs from the step value for rendering, which are returned by the Scene Info global.

 schemaPos(LWItemID item) → (x, y)

Returns the x and y position of the item in schematic viewports. This and the "SchematicPosition" command can be used by plug-ins to rearrange the schematic views.

 selected_items() → LWItemID[]

This is a Python helper method that will return a sequence of LWItemIDs that represent the currently selected items in the scene.

 setItemColorCustom(LWItemID item, color[3])

This allows setting an item's user interface display color using a floating point values from 0.0 to 1.0 for each of the red, green, and blue components. The color_var parameter is an array of doubles representing the red, green and blue components of the custom color. For example: yellow would be { 1.0, 1.0, 0.0}.

 setItemColorIndex(LWItemID item, int color)

This allows setting an item's user interface display color using a color index. This is not a surface color for final rendering. The index can be one of the 15 values defined above. You may also use a 24bit color (RGB) by setting the upper byte of a 32-bit value to 0x01. For example, yellow can be specified as 0x01FFFF00. It is preferred to use setItemColorCustom instead since custom colors will be supported in the future, whereas color indexes may not.

 set_default_item_type_color(LWItemType itemtype, color[3])

This is a Python helper method that should be used to set the floating-point color of the default item type color for the specified itemtype.

Previous topic

Fog Info

Next topic

Global Render Memory

This Page