gear.xsi.display Namespace Reference

Functions
def	inspect
	INSPECT. More...
def	highlight
	HIGHLIGHT. More...
def	toggleGroupVisibility
	VISIBILITY. More...
def	toggleDisplayParameter
	Toggle the Display parameter value for active camera. More...
def	setColor
	COLORS. More...
def	getColor
	Return the wireframecolor of the object. More...
def	getActiveCamera
	CAMERA. 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

Function Documentation

def gear.xsi.display.getActiveCamera

(

)

CAMERA.

======================================================== Return the active camera inside the 3DView

Returns

String - Camera name

def gear.xsi.display.getColor

(

obj

)

Return the wireframecolor of the object.

Parameters

obj	X3DObject - Object.

Returns

List of Double - The RGB color of the object wireframe (ie. [1,0,0] for red).

def gear.xsi.display.highlight	(		obj,
			branch = True
	)

HIGHLIGHT.

======================================================== Highlight an object inside the 3D view byu turning it's color to bright green for just a second

Parameters

obj	X3DObject - Object to highlight
branch	Boolean - True to highlight all the children of given object

def gear.xsi.display.inspect	(		prop,
			width = None,
			height = None,
			posx = None,
			posy = None
	)

INSPECT.

======================================================== Open a property inside XSI using the Create View, Property Panel Allows you to define size and position on the screen

Parameters

prop	Property - Property to display
width	Integer - Width of the created window
height	Integer - Height of the created window
posx	Integer - Position X of the created window (use negative value to position from the right side of the screen)
posy	Integer - Position Y of the created window (use negative value to position from the bottom of the screen)

def gear.xsi.display.setColor	(		obj,
			color = [0
	)

COLORS.

======================================================== Create a Display Property on the object and set the wirecolor.

Parameters

obj	X3DObject - Object.
color	List of Double - The RGB color of the object wireframe (ie. [1,0,0] for red).

Returns

Property - The newly created display property.

def gear.xsi.display.toggleDisplayParameter

(

param_name

)

Toggle the Display parameter value for active camera.

Parameters

param_name

String - Name of the parameter to toggle

def gear.xsi.display.toggleGroupVisibility

(

group

)

VISIBILITY.

======================================================== Toggle the visibility parameter value of a group

Parameters

group

Group - Group to toggle