Classes
class	Chain

class	Primitive

class	Null

class	NurbsCurve

Functions
def	generateFromXml
	========================================================

def	addNull
	NULL. More...

def	addNullFromPos
	Create a null with a given position and size. More...

def	addNullsFromPositions
	Create a nulls with a given position list . More...

def	setNullDisplay
	Set the display of a Null. More...

def	drawAxis
	Axis. More...

def	addImplicite
	IMPLICITE. More...

def	addBone
	BONE. More...

def	addBoneFromPos
	Create a bone with a given position and length. More...

def	add2DChain
	CHAINS. More...

def	alignRootToFirstBone

def	addNullChain
	Create a chain of null Used to create chain of fk controlers. More...

def	addCubeChain
	Create a chain of fk controlers (icon.cube). More...

def	addLattice

def	createOrReturnPSet
	Create or return the gear_PSet property if one was found with the same name. More...

def	createOrReturnGroup
	Create or return group. More...

def	getPrimitive
	CLASS.

Detailed Description

    This file is part of GEAR_mc.
    GEAR_mc is a fork of Jeremie Passerin's GEAR project.

    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  www.jeremiepasserin.com
    Fork Author:  Miquel Campos       hello@miqueltd.com  www.miqueltd.com
    Date:       2013 / 08 / 16

Author: Jeremie Passerin, Miquel Campos

Function Documentation

def gear.xsi.primitive.add2DChain	(	parent,
		name,
		positions,
		normal = `None`,
		negate = `False`,
		size = `1`,
		alignRoot = `False`
	)

CHAINS.

========================================================

def gear.xsi.primitive.addBone	(	parent,
		name,
		t = `XSIMath.CreateTransform()`,
		length = `1`
	)

BONE.

======================================================== Create a bone with a given transform and length.

Parameters

parent	X3DObject - Parent object.
name	String - Name.
t	SITransformation - Global transform.
length	Double - Display size.

Returns: Implicite - The newly created implicite.

def gear.xsi.primitive.addBoneFromPos	(	parent,
		name,
		position = `XSIMath.CreateVector3()`,
		length = `1`
	)

Create a bone with a given position and length.

Parameters

parent	X3DObject - Parent object.
name	String - Name.
position	SIVector3 - Global position.
length	Double - Display size.

Returns: Implicite - The newly created implicite.

def gear.xsi.primitive.addCubeChain	(	parent,
		name,
		positions,
		normal,
		negate = `False`,
		size = `1`,
		color = `[0`
	)

Create a chain of fk controlers (icon.cube).

Parameters

parent	X3DObject - Parent object.
name	String - Name.
positions	List of SIVector3 - positions of the curve points.
normal	SIVector3 - normal direction.
negate	Boolean - True to create a negative scale chain.
size	Float - Size of the controlers.
color	List of Double - The RGB color of the object (ie. [1,0,0] for red).

Returns: List of NurbCurve - The newly created curve.

def gear.xsi.primitive.addImplicite	(	parent,
		preset,
		name,
		t = `XSIMath.CreateTransform()`,
		size = `1`
	)

IMPLICITE.

======================================================== Create an implicite with a given transform and size.

Parameters

parent	X3DObject - Parent object.
preset	String - Implicite type (ie. Cube, Cone, Sphere...).
name	String - Name.
t	SITransformation - Global transform.
size	Double - Display size.

Returns: Implicite - The newly created implicite.

def gear.xsi.primitive.addNull	(	parent,
		name,
		t = `XSIMath.CreateTransform()`,
		size = `1`,
		color = `[0`
	)

NULL.

Create a null with a given transform and size.

Parameters

parent	X3DObject - Parent object.
name	String - Null name.
t	SITransformation - Null global transform.
size	Double - Null display size.

Returns: Null - The newly created null.

def gear.xsi.primitive.addNullChain	(	parent,
		name,
		positions,
		normal,
		negate = `False`,
		size = `1`
	)

Create a chain of null Used to create chain of fk controlers.

Parameters

parent	X3DObject - Parent object.
name	String - Name.
positions	List of SiVector3 - Positions of the controlers.
normal	SIVector3 - Normal vector. (Z axes)
negate	Boolean - Create a chain for negative side. (-X axes pointing forward)
size	Double - Display size.

Returns: List of Null - The newly created chain.

def gear.xsi.primitive.addNullFromPos	(	parent,
		name,
		position = `XSIMath.CreateVector3()`,
		size = `1`,
		color = `[0`
	)

Create a null with a given position and size.

Parameters

parent	X3DObject - Parent object.
name	String - Null name.
position	SIVector3 - Null global position.
size	Double - Null display size.

Returns: Null - The newly created null.

def gear.xsi.primitive.addNullsFromPositions	(	parent,
		name,
		positions,
		rot_offset = `XSIMath.CreateRotation()`,
		size = `1`,
		color = `[0`
	)

Create a nulls with a given position list .

Parameters

parent	X3DObject - Parent object.
name	String - Null name.
positions	List of SiVector3 - Positions of the controlers.
rot_off	SIRotation - Rotation offset.
size	Double - Null display size.

Returns: Null - The newly created null.

def gear.xsi.primitive.createOrReturnGroup	(	model,
		name
	)

Create or return group.

Parameters

model	Model - Model hosting the group.
name	String - Name of the group.

Returns: Group

def gear.xsi.primitive.createOrReturnPSet	(	obj,
		name
	)

Create or return the gear_PSet property if one was found with the same name.

Parameters

obj	X3DObject - Object hosting the property.
name	String - Name of the property.

Returns: Property - sn_PSet property.

def gear.xsi.primitive.drawAxis	(	parent = `xsi.ActiveSceneRoot`,
		size = `1`
	)

Axis.

========================================================

def gear.xsi.primitive.setNullDisplay	(	null,
		pri_icon = `None`,
		size = `None`,
		shd_icon = `None`,
		shd_offx = `None`,
		shd_offy = `None`,
		shd_offz = `None`,
		shd_sclx = `None`,
		shd_scly = `None`,
		shd_sclz = `None`,
		color = `None`
	)

Set the display of a Null.

Parameters

null	X3DObject - Null object.
pri_icon	Integer - Null primary icon.
size	Double - Null display size.
shd_icon	Integer - Null shadow icon.
shd_offx	Double - Null shadow offset position X.
shd_offy	Double - Null shadow offset position Y.
shd_offz	Double - Null shadow offset position Z.
shd_sclx	Double - Null shadow offset scaling X.
shd_scly	Double - Null shadow offset scaling Y.
shd_sclz	Double - Null shadow offset scaling Z.
color	List of Double - The RGB color of the Null (ie. [1,0,0] for red)

Returns

Classes

Functions

Detailed Description

Function Documentation