Alias|Wavefront

OpenAlias Plug-in Documentation


This README file describes the useful plug-in examples supplied with Alias
(as opposed to the programmer example plug-ins which can be found in
README_PROGRAMMER).

Section 1: Plug-in quick start
=============================

The quickest way to get started with plug-ins is to open the Plug-in Manager
window from the Utilities menu. Then load a few plug-ins by clicking on the
"Load Unload" box of a listed item.


Section 2: Useful Plug-ins that are in Surface Studio and Alias
===============================================================

resetTransforms.plugin
----------------------

  Installs Into:
        Palette -> Object Edit -> Reset Transforms  ("mp_objtools")

  User Notes:
    This plug-in provides a quick methodology to reset an object's
    transformations.  Translations and Rotations are set to 0 and Scale
    transforms are set to 1.0.  From the option box, it is possible to turn
    on or off any or all of the three basic transformation types (Translate,
    Rotate, Scale).  Also, resetTransforms can be told to only ascend or
    descend the Dag node hierarchy by way of the option box.

launchPaint.plugin 
-------------------

  User Notes:

    The launchPpaint plug-in launches the Xpaint palette based paint package
    from a menu item on Unix. It allows the user to specify an Alias Quantizer
    format palette file and an image, both of which will be loaded into
    Xpaint.
	
	On Windows NT, this plug-in launches MS Paint.  The format palette file and
	image functionality is not available on this platform.


Section 3: Useful plug-ins that are in Alias
============================================
     
bakeAnimation.plugin (formerly bake.plugin)
-------------------------------------------

  Installs Into:
        Menu -> Animation -> Bake  ("ap_animwinds")

  User Notes:
	This plug-in allows the user to create keyframed animations for objects
	that are animated through expressions or constraints.  The resulting
	keyframe curve is 'baked' into the channel of the object. When an
	expression is baked, a keyframed animation replaces the expression,
	and the old expression is deleted. When a point constraint is baked,
	the translation channels of the constrained DagNode are animated. When
	an orientation or aim constraint is baked, the rotation channels are
	animated.

    The option box allows the user to define which objects should be
	processed ('All' or 'Active'), whether to bake constraints and/or
	expressions, the hierarchy of the sampling and the time range and sampling
	rate. The user can also choose to delete constraints after the bake.
	If "Delete" is off, all baked constraints will be disabled.

	In the option box, if the Constraints item is selected, the user can
	choose to compensate the flipping which could happen during rendering
    with "motion blur" or "in field" set ON in Render Globals. The
	compensation can be applied to motion blur or field, or both. The user
	can also choose "Detect Only", to get the compensation message being
	printed on the prompt line, without executing the bake operation.
	
	Note: OpenAlias does not currently support prompt line entry from
	plugins, so the 'Prompt' option does nothing.


sunShine.plugin
---------------

  Installs Into:
        Menu -> Animation -> Sun Shine  ("ap_animwinds")

  User Notes:
    This plug-in will use information given to in to determine the location of
    the sun and generate a directional light to simulate it.  By activating the
    option box, the settings can be changed in two ways.  If the Time/Location
    option is chosen, the sun's position will be calculated based on the month,
    day, hour, minute, and the latitude specified.  In the Altitude/Azimuth
    selection, the altitude of the sun (in degrees from the ground), and the
    azimuth (the altitude of the sun at its maximum point during the day).


createSurface.plugin
--------------------

  Installs Into:
        Palette -> Object Edit -> Fractal Surface  ("mp_objtools")

  User Notes:
    This plug-in generates a fractal-based mountain.  Numerous parameters can
    be set to modify the final result.  In the order presented in the option
    box, they are:
        Subdivisions:    The number of times each edge of the mesh will be cut
                         in half.  Thus, setting subdivisions to 2 will result
                         in a 4x4 grid, while setting it to 6 results in a 32
                         by 32 surface.  In other words, this is the complexity
                         and resolution of the fractal surface.
        Seed:            The pseudo-random number used to generate the surface.
                         A given seed will always result in the same fractal
                         surface, if the other parameters are kept constant.
                         Changing the seed will give varying surfaces.  It is
                         best to experiment with a few values to find the best
                         surface for your application.
        Taper %:         This parameter defines the smoothness of the resulting
                         surface.  Low values yield jagged, erratic surfaces,
                         while high values result in smooth, gently sloping
                         landscapes.
        Size X/Y:        Sets the length of the sides of the surface.  One
                         corner of the generated surface is always at (0,0),
                         while the opposite corner is defined by these two
                         parameters.
        Variance X/Y/Z:    The maximum amount of change that a particular vertex
                         may go through.  It is recommended that the Z variance
                         be significantly larger than the X and Y variances.
        Level 1:         The Z-value below which the surface is shaded a rocky
                         brown colour (sand).
        Level 2:         The Z-value below which the surface is shaded a bright
                         green colour (grass).
        Level 3:         The Z-value below which the surface is shaded grey 
                         (rock).
                         Above this value, the surface is snow-coloured.
        Level Jitter:    Sets how precisely the above colour settings are
                         adhered to.  This gives a more "natural" look to the
                         surface.


createTree.plugin
-----------------

  Installs Into:
        Palette -> Object Edit -> Fractal Tree  ("mp_objtools")

  User Notes:
    The fractal tree plug-in generates a pseudo-random realistic-looking tree
    using a polygon mesh.  The tree is generated centred at the origin, and
    a variety of parameters affect its final shape.  The option box controls
    are:
        Seed:            The random number seed used in generating pseudo-
                         random numbers.  Different values will result in
                         different trees.
        Max Branch Limit:    The number of times a tree limb can branch.
        Bend:            The maximum amount of curve along a branch.
        Fork Angle:      The angle with which a branch will split.
        Branch Frequency:    The probability that a branch will split at a
                         given point.
        Gravity:         A negative value will tend to make the tree point
                         upwards, while a positive value will "pull" the tree
                         downwards.
        Grow Length:     The final length of branches.
        Trunk Taper:     The percentage of the size of the bottom end of the
                         branch segment that the other end of the segment is
                         (how quickly the branches go from trunk to twig).
        Minimum Branch Size:    If a branch gets smaller than this, it ends.
        Twist Angle:     Maximum twisting that a branch segment will go
                         through.
        Type of Leaves:  Not implemented.

    As always, the best way to determine the effects of these setting is to    
    try them out yourself.

    NOTE: Be careful setting high recursion depths. Too great a depth will
    result in Alias quitting or core dumping from lack of memory.
	Pressing the Escape key stops generation of the tree.


createTree2.plugin
------------------

  Installs Into:
        Palette -> Object Edit -> Fractal Tree  ("mp_objtools")

  User Notes:
    The fractal tree plug-in generates a pseudo-random realistic-looking tree
    using cylindrical surfaces.  The tree is generated at the origin, and
    a variety of parameters affect its final shape.  The option box controls
    are:
        Seed:           The random number seed used in generating pseudo-
                        random numbers.  Different values will result in
                        different trees.
        Max Branch Limit:    The number of times a tree limb can branch.
        Bend:           The maximum amount of curve along a branch.
        Fork Angle:     The angle with which a branch will split.
        Branch Frequency:    The probability that a branch will split at a
                        given point.
        Gravity:        A negative value will tend to make the tree point
                        upwards, while a positive value will "pull" the tree
                        downwards.
        Grow Length:    The final length of branches.
        Trunk Taper:    The percentage of the size of the bottom end of the
                        branch segment that the other end of the segment is
                        (how quickly the branches go from trunk to twig).
        Minimum Branch Size:    If a branch gets smaller than this, it ends.
        Twist Angle:    Maximum twisting that a branch segment will go
                        through.
        Type of Leaves: Not implemented.

    As always, the best way to determine the effects of these setting is to    
    try them out yourself.  Note also that the parameters have the same effect
    as the do in tree.plugin.

    NOTE: Be careful setting high recursion depths. Too great a depth will
    result in Alias quitting or core dumping from lack of memory.
	Pressing the Escape key stops generation of the tree.

