Object Info

class lwsdk.LWObjectInfo(*args)

Bases: object

Proxy of C++ PCore::LWObjectInfo class

 boneSource(LWItemID item) → LWItemID

Returns the object whose bones are being used to deform the indicated item. (An object can be deformed by the bones of another object.)

 bounds(LWItemID item) → (min[3], max[3])

Obtains the bounding box of the object.

 bumpDistance(LWItemID item) → double

This obtains the bump distance when bump displacement is enabled.

 bumpOrder(LWItemID item) → int

Returns the displacement order of the bump displacement as a displacement plugin lwsdk.LWDMF_* flag.

 clipMap(LWItemID item) → LWTextureID

Returns the texture ID of the clip map applied to item.

 dispMap(LWItemID item) → LWTextureID

Returns the texture ID of the displacement image map applied to item.

 dispMapOrder(LWItemID item) → int

Returns the displacement order of the displacement map as a displacement plugin lwsdk.LWDMF_* flag.

 dissolve(LWItemID item, LWTime time) → double

Returns the object dissolve amount at the specified time.

 edgeColor(LWItemID item, LWTime time) → color[3]

Returns the color used to render edges at the specified time.

 edgeOpts(LWItemID item) → unsigned int

Returns items's edge rendering options, which can be any of the following combined using bitwise-or:

  lwsdk.LWEDGEF_SILHOUETTE
  lwsdk.LWEDGEF_UNSHARED
  lwsdk.LWEDGEF_CREASE
  lwsdk.LWEDGEF_SURFACE
  lwsdk.LWEDGEF_OTHER
    Edge lines are drawn in the indicated areas. An unshared edge belongs to only one polygon. A crease is an edge where two polygons meet at an angle exceeding the max smoothing angle of the surface. A surface edge is where the polygons on either side have different surfaces.
  lwsdk.LWEDGEF_SHRINK_DIST
    The thickness of the lines is proportional to distance from the camera.

 edgeZScale(LWItemID item, LWTime time) → double

Returns the Edge Z Scale setting for edge rendering of item at the specified time.

 excluded(LWItemID item, LWItemID light) → int

Returns true (1) if light is excluded from item. Light exclusion is a user setting that prevents the light from affecting the rendering of the object.

 filename(LWItemID item) → char

Returns the filename for the object file.

 flags(LWItemID item) → unsigned int

Returns the state of certain object settings as bits combined using bitwise-or. Possible flags are:

  lwsdk.LWOBJF_UNSEEN_BY_CAMERA
  lwsdk.LWOBJF_UNSEEN_BY_RAYS
  lwsdk.LWOBJF_UNAFFECT_BY_FOG
  lwsdk.LWOBJF_MORPH_MTSE
  lwsdk.LWOBJF_MORPH_SURFACES (LW7.5+)
  lwsdk.LWOBJF_MATTE (LW7.5+)
  lwsdk.LWOBJF_UNSEEN_BY_ALPHA (LW7.5+)
    This is set when object alpha is set to 'Unaffected By Object'
  lwsdk.LWOBJF_ALPHA_CONSTANT_BLACK (rev.6+)
    This is set when object alpha is set to 'Constant Black'
  lwsdk.LWOBJF_DISTANCEDISSOLVE (rev.6+)
    This flag indicates that distance dissolve is enabled for the object.
  lwsdk.LWOBJF_BUMPENABLE (rev.6+)
    This flag indicates that bump displacement is enabled for the object.
  lwsdk.LWOBJF_FASTERBONES (rev.6+)
    This flag indicates the 'faster bones' feature is enabled for the object.
  lwsdk.LWOBJF_USEMORPHEDPOSITIONS (rev.6+)
    This flag indicates the 'use morphed positions' object option is enabled.
  lwsdk.LWOBJF_CONTAINS1POINTPOLYGONS (rev.6+)
    This flag indicates that the object contain one or more one-point polygons (polygons having only one vertex).
  lwsdk.LWOBJF_CONTAINSPATCHES (rev.6+)
    This flag indicates that the object contains one or more sub-patch polygons.
  lwsdk.LWOBJF_CONTAINSMETABALLS (rev.6+)
    This flag indicates that the object contains one or more meta-ball polygons.
  lwsdk.LWOBJF_CONTAINSPARTIGONS (rev.6+)
    This flag indicates that the object contains one or more partigon polygons.
  lwsdk.LWOBJF_CONTAINSCUSTOMPOLYGONS (rev.6+)
    This flag indicates that the object contains one or more custom (not internally defined) polygons.
  lwsdk.LWOBJF_NODEDISPENABLED (rev.7+)
    This flag indicates that nodal displacement is enabled for the object.
  lwsdk.LWOBJF_NODEFORMERSAPPLIED (rev.7+)
    This flag indicates that no deformation of the mesh took place, only rigid body transformations (scale/translate/rotate)
  lwsdk.LWOBJF_NODEEDGEENABLED (rev.9+)
    This flag indicates that nodal edges are enabled for the object.

 fog(LWItemID item, LWTime time) → double

Returns the amount by which item is affected by fog.

 getEdgeNodeEditor(LWItemID item) → NodeEditorID

Returns the node editor for edges associated with item.

 getGroupIndex(LWItemID objecitem) → unsigned int

!! NOT DOCUMENTED !!

 getNodeEditor(LWItemID item) → NodeEditorID

Returns the node editor for displacement associated with item.

 instancer(LWItemID item) → LWItemInstancerID

Gets the instancerID for the object.

layerLoaded(self, LWItemID objectitem) → int
 matteColor(LWItemID item, LWTime time) → color[3]

Returns the matte color set for item at the specified time.

 maxDissolveDistance(LWItemID item) → double

This obtains the maximum dissolve distance for use when distance dissolve is enabled.

 meshInfo(LWItemID item, int frozen) → LWMeshInfo

Returns a LWMeshInfo class instance for item. This is a complete description of the object's geometry.

If frozen is true (1), the mesh for objects with subpatches and metaballs will contain the geometry that results from subdivision and isosurface calculation. The LWMeshInfo::pntBasePos() method will return the same point positions that Layout uses for object coordinate texture mapping. These are completely undeformed positions in the case of regular polygons and subpatches, and positions at freezing time for metaballs and partigons. LWMeshInfo::pntOtherPos() will return the actual world coordinates used by Layout. These should only be considered final if the mesh is obtained after all object transformations have been completed.

 metaballRes(LWItemID item) → (display, render)

Returns the interface and render resolution of item's metaballs.

 morphAmount(LWItemID item, LWTime time) → double

Returns the morph amount at the specified time. If flags returns the lwsdk.LWOBJF_MORPH_MTSE bit, Multiple Target/Single Envelope morphing is enabled, and the morph amount includes an index into a chain of morph targets. Assume A's target is B, and B's target is C. Morph amounts between 0.0 and 1.0 morph A to B, while amounts between 1.0 and 2.0 morph A to C. The interpolant is the fractional part of the morph amount, and the index is the integer part.

 morphTarget(LWItemID item) → LWItemID

Returns the morph target of the specified item.

 nodeOrder(LWItemID item) → int

Returns the evaluation order of nodal displacement, one of lwsdk.LWDMF_*.

 numPoints(LWItemID item) → int

Returns the number of points in item's mesh.

 numPolygons(LWItemID item) → int

Returns the number of polygons in item's mesh.

 patchLevel(LWItemID item) → (display, render)

Returns the interface and render patch level for item's subpatches.

 polygonSize(LWItemID item, LWTime time) → double

Returns the polygon size setting at the specified time. This is a scale factor, with a default of 1.0.

 shadowOpts(LWItemID item) → unsigned int

Returns bits for shadow options:

lwsdk.LWOSHAD_SELF
lwsdk.LWOSHAD_CAST
lwsdk.LWOSHAD_RECEIVE

 shadowoffsetdistance(LWItemID item) → double

Gets the current shadow offset distance set for item.

 shrinkEdgesNominalDistance(LWItemID item, LWTime time) → double

This obtains nominal distance value at the specified time when shrink edges is enabled.

 subdivOrder(LWItemID item) → int

Returns the subdivision order as a 0-based index into a list of options.

0 - First
1 - After Morphing
2 - After Bones
3 - After Displacement
4 - After Motion
5 - Last

 thickness(LWItemID item, LWTime time, int type) → double

Returns the thickness for the specified edge type at the indicated time, where type is one of the following:

lwsdk.LWTHICK_SILHOUETTE
lwsdk.LWTHICK_UNSHARED
lwsdk.LWTHICK_CREASE
lwsdk.LWTHICK_SURFACE
lwsdk.LWTHICK_OTHER
lwsdk.LWTHICK_LINE
lwsdk.LWTHICK_PARTICLE_HEAD
lwsdk.LWTHICK_PARTICLE_TAIL

Previous topic

Item Info

Next topic

Bone Info

This Page