gear.xsi.synoptic Namespace Reference

Functions
def	select
	SELECT. More...
def	selectMulti
	Select multiple object by name. More...
def	selectAll
	Select all controlers according to filter. More...
def	quickSel
	Call or save quick selection preset. More...
def	resetSel
	RESET. More...
def	resetAll
def	keySel
	KEY. More...
def	keyMulti
def	keyAll
def	mirrorSel
def	toggleGroupVisibility
	SHOW. More...
def	toggleDisplayParameter
def	selectOrInspect
def	smooth
def	getSynoptic
	GET. More...
def	getModel
	Return the current active model. More...
def	getControlersGroups
	return a list of controlers groups. More...
def	getAllControlers
	Return all the controlers according to filter. More...

Variables
string	SYNOPTIC_NAME = "gear_Synoptic"
string	CTRL_GRP_PREFIX = "controlers_"
string	QUICKSEL_PARAM_PREFIX = "QuickSel_"
string	RESET_ACTION_NAME = "reset"
string	INFO_PROP_NAME = "info"
string	GLOBAL_CTL_NAME = "global_C0_ctl"
string	OGL_PARAM_NAME = "oglLevel"

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

Function Documentation

def gear.xsi.synoptic.getAllControlers

(

)

Return all the controlers according to filter.

Returns

XSICollection

def gear.xsi.synoptic.getControlersGroups

(

)

return a list of controlers groups.

Returns

List of Group

def gear.xsi.synoptic.getModel

(

)

Return the current active model.

Returns

Model

def gear.xsi.synoptic.getSynoptic

(

)

GET.

======================================================== Return the synoptic property.

Returns

Property

def gear.xsi.synoptic.keySel	(		in_mousebutton,
			in_keymodifier
	)

KEY.

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

def gear.xsi.synoptic.quickSel	(		in_mousebutton,
			in_keymodifier,
			port = "A"
	)

Call or save quick selection preset.

Parameters

in_mousebutton	Integer - 0 Left, 1 Middle, 2 Right
in_keymodifier	Integer - See source for information
port	String - Name of the port to use

def gear.xsi.synoptic.resetSel	(		in_mousebutton,
			in_keymodifier
	)

RESET.

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

def gear.xsi.synoptic.select	(		in_mousebutton,
			in_keymodifier,
			name = None
	)

SELECT.

======================================================== Select object by name, according to mouse/key combo

Parameters

in_mousebutton	Integer - 0 Left, 1 Middle, 2 Right
in_keymodifier	Integer - See source for information
name	String - object name to select

def gear.xsi.synoptic.selectAll	(		in_mousebutton,
			in_keymodifier
	)

Select all controlers according to filter.

Parameters

in_mousebutton	Integer - 0 Left, 1 Middle, 2 Right
in_keymodifier	Integer - See source for information

def gear.xsi.synoptic.selectMulti	(		in_mousebutton,
			in_keymodifier,
			object_names,
			exclude = []
	)

Select multiple object by name.

Parameters

in_mousebutton	Integer - 0 Left, 1 Middle, 2 Right
in_keymodifier	Integer - See source for information
object_names	String - object names to select
exclude	String - object names to exclude from selection select

def gear.xsi.synoptic.toggleGroupVisibility	(		in_mousebutton,
			in_keymodifier,
			group_name
	)

SHOW.

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