Weightmap (object)

Weightmap Weightmap Weightmap Detachable Detachable Weightmap->Detachable Persistable Persistable Weightmap->Persistable

Members

String name The name of the weightmap, which is used as the name of the geometry attribute on the polygon mesh.
Color color The color of the weightmap, used when displaying the weightmap in the viewport.
PolygonMesh mesh the mesh that the weightmap is connected to.
Xfo meshTransform the transform of the mesh that the weightmap is connected to.
ScalarAttribute weightMapAttr The Scalar attribute that is applied ot the connected mesh.
SurfaceAttributePaintManipulator paintManipulator The Manipulator used to interactively modify the weightmap.

Methods

  Weightmap ( in Weightmap other )
  Weightmap ()
  activateManipulator ! ()
  attach ! ()
Weightmap clone ? ()
  connect ! ( in PolygonMesh mesh, in Xfo meshTransform )
  deactivateManipulator ! ()
  detach ! ()
  display ! ( in Boolean display )
Boolean isConnected ? ()
  loadDataFromString ! ( in PersistenceContext context, in String data )
String saveDataToString ? ( in PersistenceContext context )
  setColor ! ( in Color color )
  setGraph ! ( in String graphName )
  setInstance ! ( in InlineInstance instance )
  setName ! ( in String name )

Methods in detail

Weightmap ( in Weightmap other )

copy constructor

Weightmap ()

Weightmap.activateManipulator! ()

Activate the Weightmap manipulator

Weightmap.attach! ()

Called by the Splice when the owning splice container is restored from then undo stack.

Weightmap Weightmap.clone? ()

clone method

Weightmap.connect! ( in PolygonMesh mesh, in Xfo meshTransform )

Connects the weightmap to a polygon mesh. When a weightmap is connected to a polygon mesh, it sets up the geometry attribute in preparation for painting.

mesh the mesh to connect the weightmap to.
meshTransform The transform of the mesh. This is required to be able to dispaly the weightmap correctly.

Weightmap.deactivateManipulator! ()

Deactivate the Weightmap manipulator

Weightmap.detach! ()

called by the Splice when the owning splice container is deleted and moved onto the undo stack.

Weightmap.display! ( in Boolean display )

Displays the weightmap in the viewport using an overlay shader to render the painted region.

display Pass true or false to enable/disable display of the weightmap.

Boolean Weightmap.isConnected? ()

Returns true if the weightmap has already been connected to a polygon mesh.

Weightmap.loadDataFromString! ( in PersistenceContext context, in String data )

Load the weightmap data back from a string.

注釈

the Weightmap looks within the file system where the DCC file is being loaded from for the Weightmap binary file. This file should have the same name as the DCC file, but with the suffix ‘_WeightmapNameBinCache.bin’

String Weightmap.saveDataToString? ( in PersistenceContext context )

Save the weightmap to a string.

注釈

The Weightmap writes out a binary file to disk in the same location as the DCC scene file with a suffix ‘_WeightmapNameBinCache.bin’

Weightmap.setColor! ( in Color color )

Sets the color of the weightmap, used when displaying the weightmap in the viewport.

the color of the weightmap.

Weightmap.setGraph! ( in String graphName )

Weightmap.setInstance! ( in InlineInstance instance )

sets the instance of the weight used for realtime rendering

Weightmap.setName! ( in String name )

Sets the name of the weightmap, which is used as the name of the geometry attribute on the polygon mesh.

the name of the weightmap.