The API Documentation for the GEAR Python Libraries has been generated using Doxygen and is available online at this link : GEAR API Documentation



You can find information on how to use the commands of the Gear menu by selecting the category right here :

PRIMITIVE
    + Property
    + Icon
SELECT
CURVE
MODELING
RIGGING
    + Tools
    + Transform
    + Solvers
    + Renamer
CHARACTER
DEFORM
    + Shape
    + Envelope
    + WeightMap
ANIMATION
IMPORT / EXPORT


PRIMITIVE
PROPERTY
This will help you create a GEAR PSet. This is a custom property in which you can store it’s own layout and logic. This way you can dynamically generate custom properties with a custom layout and have them persisting even after reloading the scene. It is basically an evolution of the Custom Property With Persistent Layout by Daniele Niero as describe in this xsi blog post. (Thanks to him !), but the GEAR version is written in Python and can also store the logic of the PPG.

New Parameter Set
how to use it : select an object.
Will create a new Parameter Set on selected object.
Debug Parameter Set
how to use it : select a GEAR PSet.
To force the property to display the layout and logic code.

ICON
These are all the rigging icons available. Even if curves are slower to display than nulls and a lot of people recommend to use null as controlers inside Softimage. We decided to go with curves as we can shape them exactly the way we want. We feel it is important for animators to have clear and easy to grab controlers. Note that inside the gear rigging system you can replace any curve controler with a null icon.

- Top -

SELECT

Symmetrize Component Selection
how to use it : select some points/edge or faces (you need a symmetry map).
Select the symmetrical components.
Mirror Component Selection
how to use it : select some points/edge or faces (you need a symmetry map).
Select both the originals and symmetrical components.
Select stars 5
how to use it : select a geometry.
Selects all the vertices that have 5 edges connected to them.
Select stars 6+
how to use it : select a geometry.
Selects all the vertices that have 6 or more edges connected to them.

- Top -

CURVE

Constrained Curve Linear
how to use it : select reference objects.
Creates a curve from your selection and constraint each vertex using a
ClusterCenterOp. the curve will be linear (degree 1).
Constrained Curve Cubic
how to use it : select reference objects.
Creates a curve from your selection and constraint each vertex using a
ClusterCenterOp. the curve will be cubic (degree 3).
Resample Curve
how to use it : select a curve.
Resample the curve on itself to eventually spread the vertex on it
Merge Curves
how to use it : select two or more curves.
Merges them in one.
Split Curve
how to use it : select one curve with multiple subcurves
Creates one new curve out of each subcurves.

- Top -

MODELING

Match geometry
how to use it : select the geometry, pick session is asking for reference.
Match the geometry points position to another. Geometry can be match in local or global coordinates and a blend is available to add more or less influence.
Symmetrize Points
how to use it : select some points (you need a symmetry map).
You need a symmetry map. Select the points you want to symmetrize and run.
Mirror Cluster
how to use it : select a cluster (you need a symmetry map).
Creates a symmetrical cluster from selected cluster.
Merge with clusters
how to use it : select some geometries.
Will merge selected geometries keeping the clusters.
Split Polygon Islands
how to use it : select a geometry.
Will split selected geometry in sub islands component.

- Top -

RIGGING
TOOLS

Get Distance
how to use it : select two or more objects.
Log the distance between selected objects.
Draw Axis
how to use it : select objects.
Create 3 curves children of the selected object representing the x, y and z
axis. Useful to check the orientation of an object.
Add Null Parent
how to use it : select object.
Create a null parent of selection with the same transform.
Add Null Child
how to use it : select object.
Create a null child of selection with the same transform.

TRANSFORM
Work exactly like the Softimage native Match transform, but the native one sometimes doesn’t work.
Also this one can match Translate and Rotation only or Scaling and Rotation...

SOLVERS
Help you to apply one of the custom solvers. There is only a few available right now. The rest of them are only accessible through scripting.

Create Spline Kine
how to use it : select objects.
Create Roll Spline Kine
how to use it : select objects

RENAMER
A custom property that helps you to rename your objects, chains...

- Top -

CHARACTER
This is the menu for the GEAR’s Rigging System. Please refers to the video on the Vimeo GEAR’s channel to get more information about it. - Rig fix : sample curve op wasn't working because of wrong operator name

Build From Selection
how to use it : select a guide or part of a guide.
Generate a rig from selected guide.
Build From File
how to use it : file browser prompt to pick a file.
Generate a rig from a given file (xml definition of a guide).
Guide Tools
how to use it : ui is prompt to provide tools.
Tool set to create rig guide.
Update Guide
how to use it : select a guide model.
Used to update the guide if one of the component need new settings. Your
existing guide will be prefixed with “_old” and a new one will be available
in the scene. Not that it is not necessary to update a guide that just been
imported from xml definition as guide are automatically updated on load.
Import Guide
how to use it : file browser prompt to pick a file.
Import guide in the scene from a file (xml definition of a guide).
Export Guide
how to use it : file browser prompt to pick a file.
Export guide to xml.

- Top -

DEFORM
SHAPE
Tool set for shape edition (previously released under the name gShapeTools)

Select Shape Points
how to use it : Select a shape.
Select all the point of the geometry that are deformed by the selected shape
Reset Shape Points
how to use it : Select some points and a shape.
The point will be reset to its original position.
Scale Shape Points
how to use it : Select some points and a shape.
The shape deformation for selected points can be eased or exaggerated.
Smooth Shape Points
how to use it : Select some points and a shape.
Use the neighbor values of the points to create an average value.
Symmetrize Shape Points
how to use it : select some points and a shape (you need a symmetry map).
Symmetrize the shape value to opposite side.
Duplicate Shape Key
how to use it : select a shape key.
Duplicate the shape key.
Move Shape Key
how to use it : select a shape key, pick session to select the new cluster.
Copy/Paste or Cut/Paste the shape in another cluster.
Reset Shape Key
how to use it : select a shape key.
Reset all the point of the shape key.
Merge Shape Key
how to use it : select two or more shape key.
Merge all the shape key value in a new single shape key.
Split Shape Key
how to use it : select a shape key.
Split the shape key in two shape (using point coordinates or clusters).
Mirror Shape Key
how to use it : select a shape (you need a symmetry map).
Create a mirrored copy of selected shape.
Copy Shape Key
how to use it : select a shape, launch pick session to select source shape.
Copy the shape values from a shape to another.

ENVELOPE

Select Unormalized
Points
how to use it : select an enveloped geometry.
Select the unnormalized point from envelope.
Create Symmetry
Mapping Template
how to use it : select an enveloped geometry.
Create a symmetry mapping template using the naming convention for right
and left. (Avoid error when two deformers are at the exact same position).
Copy Weight point 2
point
how to use it : select one or more points, pick one point for reference.
Copy the weight of picked point to selected point.
Copy Weights
Average
how to use it : select one or more points, pick one or more point for
reference.
Copy the average value of picked point to selected points.
Average Central Axis
Point Weights
how to use it : select one or more points.
Symmetrize the weight of selected point to right and left deformers.
Replace Deformer how to use it : select a geometry, pick one or more deformers to remove,
pick one or more deformers to use.
Replace one or more deformers by one or more other objects in the
envelope.
Normalize Weights how to use it : select an enveloped geometry or some points.
Normalize weights of selected points.
Normalize to
Deformer
how to use it : select an enveloped geometry or some points, pick target
deformer.
Normalize weights of selected points to picked deformer.
Prune Weights how to use it : select an enveloped geometry.
Remove influence of deformers smaller than threshold and normalize the
result.
Rebuild Envelope how to use it : select an enveloped geometry.
Rebuilt the envelope solver to get the correct normalisation warning and
colors.
Remove Unused
Envelope Cls
how to use it : select an enveloped geometry.
Delete unused envelope clusters.
Copy Envelope With
Gator
how to use it : select target geometries, pick enveloped gemetries.
Transfer weight using gator on multiple geometries.
Mirror Objects
Weights
how to use it : pick enveloped geometry, pick target geometry.
Mirror weights on two symmetrical objects.

WEIGHTMAP

Select WeightMap
Points
how to use it : Select a weightmap.
Select point affected by the weigthmap
Reset WeightMap
Points
how to use it : Select some points and a weightmap.
Set the value of selected point in the weightmap to 0.
Set WeightMap
Points
how to use it : Select some points and a weightmap.
Set the value of selected point in the weightmap.
Scale WeightMap
Points
how to use it : Select some points and a weightmap.
Scale the value of selected point in the weightmap.
Smooth WeightMap
Points
how to use it : Select some points and a weightmap.
Smooth the value of selected point in the weightmap.
Symmetrize
WeightMap Points
how to use it : Select some points and a weightmap (you need a symmetry
map)
Symmetrize the value of selected point in the weightmap.

- Top -

ANIMATION

Open synoptic Open the synoptic view. You need to have rigs in the scene.
Mirror Pose Mirror the transform on selected controlers.
Mirror Animation Mirror the animation on selected controlers.
Edit Mirroring
Template
Edit the mirroring rules.

- Top -

IMPORT / EXPORT

Import Skin how to use it : Select geometries.
Import skin on selected geometries.
Note - right now, skin only support envelope
Import Envelope how to use it : Select geometries.
Import envelope on selected geometries
Export Skin how to use it : Select geometries
Export skin of selected geometries, xml definition.
Export Envelope how to use it : Select geometries
Export envelope of selected geometries, xml definition.
Export Object how to use it : Select an object
Export object, xml definition.

- Top -