gear.xsi.weightmap Namespace Reference

Functions
def	addWeightMap
	WEIGHTMAP. More...
def	setWeightMapMinMax
	Set the min and max value of the weightmap. More...
def	getWeightMapPoints
	WEIGHTMAP POINTS. More...
def	resetWeightMapPoints
	Reset the value of selected point in the weightmap. More...

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.weightmap.addWeightMap	(		cls,
			name = "WeightMap",
			min_value = None,
			max_value = None
	)

WEIGHTMAP.

======================================================== Create a new weight map to given cluster.

Parameters

cls	Cluster
name	String - The name of the weightmap
min_value	Double - The minimum limit of the weightmap
max_value	Double - The maximum limit of the weightmap

Returns

Property - The newly created WeightMap

def gear.xsi.weightmap.getWeightMapPoints	(		wmap,
			threshold = 1E-6
	)

WEIGHTMAP POINTS.

======================================================== Return all the point index affected by the weightmap.

Parameters

wmap	WeightMap
threshold	Double

Returns

List of Integer - The list of index

def gear.xsi.weightmap.resetWeightMapPoints	(		wmap,
			points
	)

Reset the value of selected point in the weightmap.

Parameters

wmap	WeightMap
points	List of Integer - Indexes of point to reset.

def gear.xsi.weightmap.setWeightMapMinMax	(		wmap,
			min_value = None,
			max_value = None
	)

Set the min and max value of the weightmap.

Parameters

wmap	WeightMap
min_value	Double - The minimum limit of the weightmap
max_value	Double - The maximum limit of the weightmap

Returns

Boolean - False if fails