Dissolver Documentation

About

This Layout script gives you easy access to the Dissolve envelope of selected objects. This script was created as a companion script for ShiftKeysPlus. With this script you can setup dissolve envelopes for multiple items very easily and then use ShiftKeysPlus to offset the timing.

Installation

After downloading, unzipping and saving the file to your hard drive, add the scripts to Layout through the 'Add Plugins' button found in the 'Utilities' tab. Access the script through the 'Master Plugins' window found in the 'Utilities' tab.

Licensing

The feedback field in the ui will indicate that the script is in demo mode with the text "Demo (XXXXX)" where "XXXXX" will be your dongle id. When purchasing a license you must provide your dongle id. An unlicensed version of the script only supports one selected item.

After purchasing and receiving your license, put the ShiftKeysPlus.lic file into the same folder as ShiftKeysPlus.pyc and Dissolver.pyc. I recommend keeping ShiftKeysPlus.pyc and Dissolver.pyc in the same folder. The feedback field in the ui will indicate that the script is licensed with the text "Licensed".

Usage

The percentage of object dissolve.

This will open the Graph Editor with the dissolve envelopes for the selected objects.

This will remove the dissolve envelope for the selected objects.

Options to create a new keyframe based on the user's curve type choice.

Numeric fields that become enabled when TCB curve type choice is enabled.

The 'X' buttons will set their numeric field to the default values.

This will set a keyframe for the selected objects at the current frame with the percentage value from Object Dissolve

This sets a 0% dissolve stepped keyframe at the current frame.

This sets a 100% dissolve stepped keyframe at the current frame.

Close the panel.

This launches the documentation.

For additional support, please see the FAQ page.

1.0

• Initial Release

Layer Panel Plus

About

This Modeler script adds multi-selection and batch editing ablities to the Layer Panel.

Licensing

The feedback field in the ui will indicate that the script is in demo mode with the text "Demo (XXXXX)" where "XXXXX" will be your dongle id. When purchasing a license you must provide your dongle id. An unlicensed version of the script only supports a maximum of 20 layers.

After purchasing and receiving your license, put the LayerPanelPlus.lic file into the same folder as LayerPanelPlus.pyc. The feedback field in the ui will indicate that the script is licensed with the text "Licensed".

Usage

• Curr - This will show the currently active layers.
• Mesh - This will show all the layers that contain geometry data.
• FG - This will show all the layers that are in the foreground.
• BG - This will show all the layers that are in the background.
• All - This will show all the layers that are used in the model.

This will select all the items in the list.

This will invert the current list selection.

• FG - This will set the selected layers in the list to be foreground layers.
• BG - This will set the selected layers in the list to be background layers.
• Inv BG -
• Swap FG<->BG - This will swap the foreground layers in the list to be background and vice versa.

• #+ - This will sort the list in ascending numerical order.
• #- - This will sort the list in descending numerical order.
• A-Z - This will sort the list in ascending alphabetical order.
• Z-A - This will sort the list in descending alphabetical order.

• On - Clicking on item(s) in the list will make the layer active in Modeler.
• Off - Clicking on item(s) in the list will not make the layer active in Modeler. With a model with a high number of layers, it is recommended to work with Autoset Off as multi-selecting a high number of layers results in significant slow down.

This string field is where you can enter a string to filer your list of layers. Multiple strings can be searched by comma separating them (box,ball,z).

• Mesh - This will apply your search string to only layers that contain geometry data.
• FG - This will apply your search string to only layers that are in the foreground.
• BG - This will apply your search string to only layers that are in the background.
• All - This will apply your search string to all layers.
• Curr - This will apply your search string to only the active layers.
• Reset - This resets your search string field.

The following features provided advanced renaming features for your layers.

• Prefix - This field lets you provide a prefix to your selected layer(s).
• Name - This field lets you provide a new name for your selected layer(s).
• Suffix - This field lets you provide a suffix to your selected layer(s).
• Rename - This button performs the rename operation.
• Padd - This button enables the digit padding option.
• Start - This number field lets you enter in where the padding count will start from.
• # digits - This pulldown lets you specify how many digits the padding will padd to.
• 1 = 1
• 2 = 01
• 3 = 001
• 4 = 0001
• sep - This pulldown lets you specify if and what type of separator you want to add between your layer name and the digit padding.

The Collapse button will combine the geometry of the selected layers into the lowest number layer of your selection. The string field is where you can give the the collapsed layer a new name.

This button will clear out all the layers that contain no geometry.

This button will swap the name and geometry of two layers.

This button will insert a user defined number of blank layers after the location of the selected layers.

This button will clone the geometry of the selected layers. It's recommended to clone layers with the padding options enabled.

For additional support, please see the FAQ page.

1.0

• Initial Release

FAQ

I found a bug. What should I do?

I make every effort to make my scripts bug free but it happens. Feel free to reach out to me through the Contact page and tell me about the bug. Please provide the steps necessary to recreate the bug. Without the steps, it becomes very time consuming for me to track the bug down.

I have a feature request. Can you add it?

Feature requests are great and you're more than welcome to tell me about it through my Contact page. I can't guarantee I can implement it as I make every effort to make my script as production ready as possible. I have a full time job and scripting is more of a hobby for me so I just might not have the time to add the new feature. If the script is uncompiled, you're more than welcome to add the functionality you want.

I have a great idea for a script. Can you make it?

Maybe. Several factors will determine if I can make your script.

• Do I have the time? My full time job takes up a lot of time and energy so I just might not be available.
• Is it even possible with the SDK.
• Am I skilled enough to create this script. I'm not an expert with the LightWave SDK. I would describe myself as a casual scripter. So if your request deals with areas of the SDK that I'm not familiar with, that'll be an obstacle. I don't mind the challenge but with limited free time I just might not have the free time. That being said, you're more than welcome to ask.

I bought your script. Can I get a refund?

Sorry but all sales are final. I offer a limited version of the script for evaluation purposes or for those that don't want to buy the unlocked version. The only difference with the free/evaluation version is that your workflow will be restricted (number of possible items, number of layers in a file, etc) but the script has the same capabilities as a licensed one.

I bought your script and provided the incorrect dongle id. What should I do?

Send me the correct dongle id through my Contact page. Note: I reserve the right to deny sending you a new license if I suspect you're requesting new licenses to get around buying additional licenses.

I'd like to get into scripting for LightWave. Do you have any recommendations on how to get started?

Well, I hope you have a lot of patience. Scripting isn't hard but it will take awhile to learn. Especially LightWave's implementation of python as what you need is spread out across the python, the C and the Lscript SDK. I learned scripting by dissecting other people's scripts and that's why I keep many of my scripts uncompiled. I would recommend starting there. Lscript is the easier of the two scripting languages but I would recommend going straight to python as Lscript will eventually be deprecated. Below are links to good resources.

• LScript
• The LScript section of the NewTek forum is a good area to learn. I've learned a lot. It's not unusual for someone to ask for help and for another forum member to actually post the code.
• Mike Green's lscript page is good if you're looking for lscript reference.
• Python
• The LScript section of the NewTek forum is a good area to learn for the same reasons stated above.
• Ryan Roye has an Introduction to Python tutorial. I have not seen it but if it's like any of his other tutorials, I'm sure it is excellent.
• Just Add Milk has examples of LightWave python code. It has excellent examples of how to build the ui panels in python.

Shift Keys Plus Documentation

About

This Layout script will shift and or scale the keyframes of selected items. Children of a selection can also inherit the offset of the main parent item. Selected items can also have the frame offset/scale be randomized. The idea behind this script is to replicate After Effects' sequence layers function but has since grown to include features that assist with general animation.

Installation

After downloading, unzipping and saving the file to your hard drive, add the scripts to Layout through the 'Add Plugins' button found in the 'Utilities' tab.

Access the script through the 'Master Plugins' window found in the 'Utilities' tab.

Licensing

The feedback field in the ui will indicate that the script is in demo mode with the text "Demo (XXXXX)" where "XXXXX" will be your dongle id. When purchasing a license you must provide your dongle id. An unlicensed version of the script only supports a maximum of 3 selected items at a time.

After purchasing and receiving your license, put the ShiftKeysPlus.lic file into the same folder as ShiftKeysPlus.pyc. The feedback field in the ui will indicate that the script is licensed with the text "Licensed".

Usage

The choice to affect only the selected items or the selected items plus their children. Children items will inherit the offset that is applied to the selected parent. The ability to affect child items is disabled in the demo.

• Feedback field - This field will track your item selection. Multi-selections will display 'multiple'.
• Lock - This toggle button will keep your selection locked in ShiftKeysPlus.
• + - This button will replace the locked selection with what is currently selected.
• Relation feedback - This field will provide feedback if your locked selection matches or does not match what is currently selected. "=" means the locked selection equals what is selected in Layout. "!=" means the locked selection does not match what is selected in Layout.

The Position, Rotation and Scale buttons act as invert buttons for their respective channels. Individual channels can be enabled or disabled by toggling them on or off.

The Reset button enables all of the channels for their respective group.

Affect dissolve envelopes.

Affect the Postion, Rotation and Scale constraint envelopes.

Affect morph envelopes.

Options to filter which morph envelopes should be affected. Mutliple search items can be entered by separating them with a comman. Ex. 'Blink,Smile'. This feature is disabled in the demo.

• None - No filtering will performed.
• Include - Filter by including morphs that match string entry.
• Exclude - Filter by excluding morphs that match string entry.

Editable text field that will filter morph envelopes.

The 'X' buttons will reset the text field to blank.

These buttons apply any offsets to, if any, the Intensity and Color envelope of a Light.

This button applies any offsets to, if any, the Zoom envelope of a Camera.

The amount to offset, in either frames or seconds.

The amount to randomize each selected item's offset, in either frames or seconds.

The amount to scale each selected item's animation.

The amount to randomize the scale of each selected item's animation.

• None - This choice will ignore the time slider's location from all operation.
• GoTo - This choice will move the start of your selected item(s) motion to the time slider's location in time.
• From - This choice will only affect the keyframes that are after the time slider's location in time.
• Custom - This choice will unghost the numeric fields allowing you to enter in custom frame ranges to perform your operation.

Numeric fields to specify the frame range to perform your operation. The '+' buttons will populate the field based on current time slider location.

The 'X' buttons will set their numeric field to the default values.

• Shift - Selected item(s) keyframes will only shift.
• Stagger - Keyframe offset will increase for each selected item(s).

These keys perform a 1 frame shift/stagger.

Numeric fields to specify the frame range to perform your operation. The '+' buttons will populate the field based on current time slider location.

The amount to scale each selected item's animation.

The 'X' buttons will set their numeric field to the default values.

• [-----] - Keyframess outside of the First and Last Frame are ignored.
• <-----] - Keyframes before the First Frame will retain their relative position after scaling.
• [-----> - Keyframess after the Last Frame will retain their relative position after scaling.
• <-----> - Keyframes before and after the Last Frame will retain their relative position after scaling.

From is a live field and will update as you scrub the timeline. Enabling the 'Grab' button will prevent the value from updating. The intent is that scaling the timing of your keyframe is based on where your timeslider is. Think of it like stretching your geometry with Mouse Center active.

Perform the scale operation

Delete keyframes within the First Frame and Last Frame range.

Numeric fields to specify the frame range of area to copy. The '+' buttons will populate the field based on current time slider location.

This feature will copy the animation that's defined by the First and Last Frame values and copy it to the location of the time slider. This feature is disabled in the demo.

• Replace - Copied keyframes will replace existing keyframes found at time slider location.
• Merge - Copied keyframes will merge with existing keyframes found at time slider location.
• Insert&Push - Copied keyframes will be inserted at time slider location and keyframes found at and after time slider location will be pushed down the timeline.

Delete a keyframe at the user specified keyframe value.

at is a live field and will update as you scrub the timeline. Enabling the 'Grab' button will prevent the value from updating.

Options to create a new keyframe based on the user's curve type choice.

Numeric fields that become enabled when TCB curve type choice is enabled.

The 'X' buttons will set their numeric field to the default values.

Option to ignore items that are locked in the Scene Editor.

Option to close the Graph Editor before keys are processed and to reopen the Graph Editor after keys are processed. Having the Graph Editor closed results in much faster processing.

• Close - Close the panel.
• Undo - This will undo your shifted animation. Note: Only one level of undo is supported.

These keys perform a 1 frame shift/stagger.

This launches the documentation.

For additional support, please see the FAQ page.

2.3

• Code cleanup.

2.2

• Item selection locking.

2.1.2

• UI fix for Mac for scale compensation options.
• Graph Editor toggle option defauls to 'No'.

2.1.1

• Close button not destroying UI panel properly.
• Precision math fix for Round option.
• Launcher script no longer creates multiple UI instances.

2.1.0

• Morph filtering.
• Added feature to copy keyframes.
• Added feature to delete keyframes.
• Graph Editor toggle to speed up performance.
• Changes to how Custom Shift and Stagger field is calculated. User can now specify a single frame range to move a single keyframe. Previously the user had to pick a value before and after a single keyframe.
• ShiftKeysPlus will no longer persist if instance is removed from Master Plugins list.

2.0.1

• Fix Layout crash when clearing a scene after ShiftKeysPlus panel has been created and closed.

2.0

• Choice to affect children is in a different menu section as it was grouped with channel buttons.
• Section to scale the timing of keyframes.
• Section to add and delete keyframes.

1.8

• First and Last Fields query preview range, not Render Globals range.
• Panel no longer persists when scene is cleared or a new scene is loaded.
• Undo button is only active when an undo is available.
• Code cleanup.

1.7

• Add code to account for precision difference between key time and scene time.
• Changes to how envelopes are queried. This change makes it easier to support additional envelopes.
• Add support for constraint envelopes.
• Add support for Light Intensity and Color.
• Add support for Camera Zoom.
• Add option to skip items that are locked in the Scene Editor.
• Add launcher script to automatically add ShiftKeysPlus to Master Plugins and launch it or launch the existing entry if one already exists.

1.6

• Fix hierarchy crawling. Crawling through child items was terminating prematurely.
• Added buttons to get 'First Frame' and 'Last Frame' based on time slider location.

1.5

• Fix OS ui issue.
• Added quick stagger keys "<<" and ">>" to let you easily stagger by 1 frame. Scale, Rand Scale and Rand offset are ignored when using these buttons.
• GoTo option now works with Stagger.

1.4

• Changed stagger behavior to not offset the first item. This makes the behavior similar to sequencing layers in AfterEffects. This behavior has been reported to be more intuitive.
• Added the option to only shift keys that are past the time slider location.
• Added quick shift keys "<<" and ">>" to let you easily shift by 1 frame. Scale, Rand Scale and Rand offset are ignored when using these buttons.
• Option to shift or stagger based on specific keyframe range.

1.3

• Change 'Move to current time' option to use location of time slider as absolute value instead of additive.
• Changed names of menu items to make usage clearer.
• Added buttons to reset numeric fields to default values.

1.2

• Separate buttons to shift or stagger the selected items.

1.1

• Bug fix in licensing system
• UI layout optimization to address different monitor resolutions

1.0

• Initial Release