gear::xsi::animation Namespace Reference

xsi animation methods, keys, mirror animation, apply action... test More...

Data Structures
class	PlayControl
	Class to easily access the playcontrol object inside XSI. More...
Functions
def	getKeyableParameters
	Return a collection of keyable parameters for input objects.
def	setKey
	Set a key on keyable parameters for given controler at current keyable frame.
def	createMirrorCnxTemplate
	Create the mirror connection template.
def	addMirroringRule
	Adding a mirroring rul to the connection grid for given controlers.
def	mirror
	Transfer the pose/animation of givben controlers according to the rules define in the connection template.
def	invertSource
	Inverse the source value.
def	applyAction
	Apply action to model for given controlers.
Variables
string	MIRROR_PROP_NAME = "mirror_cnx"

---

Detailed Description

xsi animation methods, keys, mirror animation, apply action... test

    This file is part of GEAR.

    GEAR is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/lgpl.html>.

    Author:     Jeremie Passerin      geerem@hotmail.com
    Company:    Studio Nest (TM)
    Date:       2010 / 11 / 15

Author:

Jeremie Passerin

---

Function Documentation

def gear::xsi::animation::getKeyableParameters

(

in_controlers

)

Return a collection of keyable parameters for input objects.

Parameters:

in_controlers

XSICollection

Returns:

XSICollection of Parameters

def gear::xsi::animation::setKey

(

controlers = xsi.Selection

)

Set a key on keyable parameters for given controler at current keyable frame.

Parameters:

controlers

an XSI Collection of controler, if None, current selection is used

Returns:

true if the controlers has been succefully keyed

def gear::xsi::animation::createMirrorCnxTemplate	(		model,
			in_controlers = None
	)

Create the mirror connection template.

Parameters:

	model	Model - Model to add the template to
	in_controlers	XSICollection - Controlers to add to the template

Returns:

Grid

def gear::xsi::animation::addMirroringRule	(		ctl,
			cnx_grid,
			inversed_params = [],
			delUnused = False
	)

Adding a mirroring rul to the connection grid for given controlers.

Parameters:

	ctl	X3DObject - Controler to add to the mirroring template
	cnx_grid	Grid - The connection grid
	inversed_params	List of String - List of the fullname of parameters to inverse
	delUnused	Boolean - True to remove rules that mirror to themself

Returns:

Dictionary - Connections

def gear::xsi::animation::mirror	(		controlers = xsi.Selection,
			animation = False,
			frame_offset = 0,
			considerTime = False,
			frame_in = 0,
			frame_out = 0
	)

Transfer the pose/animation of givben controlers according to the rules define in the connection template.

Parameters:

	controlers	XSICollection - Controlers to mirror
	animation	Boolean - True to mirror the FCurve and not only the static value
	frame_offset	Integer - Offset original animation
	considerTime	Boolean - True to use the in and out frame
	frame_in	Integer - Start frame of animation to mirror
	frame_out	Integer - End frame of animation to mirror

def gear::xsi::animation::invertSource

(

source

)

Inverse the source value.

Parameters:

source

def gear::xsi::animation::applyAction	(		model,
			action_name,
			controlers = None
	)

Apply action to model for given controlers.

Parameters:

	model	Model - model to apply the action to
	action_name	String - Name of the action to apply XSICollection - Controlers to apply the action to (None, to apply to all)