gear::xsi::icon Namespace Reference

Functions
def	primOrIcon
	Create a icon or a primitive form primitive definition.
def	cube
	Create a curve with a CUBE shape.
def	pyramid
	Create a curve with a PYRAMIDE shape.
def	square
	Create a curve with a SQUARE shape.
def	flower
	Create a curve with a FLOWER shape.
def	circle
	Create a curve with a CIRCLE shape.
def	cylinder
	Create a curve with a CYLINDER shape.
def	compas
	Create a curve with a COMPAS shape.
def	foil
	Create a curve with a FOIL shape.
def	diamond
	Create a curve with a DIAMOND shape.
def	leash
	Create a curve with a LEASH shape.
def	cubewithpeak
	Create a curve with a CUBE WITH PEAK shape.
def	sphere
	Create a curve with a SPHERE shape.
def	arrow
	Create a curve with a ARROW shape.
def	crossarrow
	Create a curve with a CROSS ARROW shape.
def	bendedarrow
	Create a curve with a BENDED ARROW shape.
def	bendedarrow2
	Create a curve with a BENDED ARROW shape.
def	cross
	Create a curve with a CROSS shape.
def	glasses
	Create a curve with GLASSES shape.
def	lookat
	Create a curve with a LOOKAT shape.
def	eyearrow
	Create a curve with a EYE ARROW shape.
def	anglesurvey
	Create a curve with a ANGLE SURVEY shape.
def	eyeball
	Create a curve with a EYE BALL shape.
def	rectanglecube
	Create a curve with a RECTANGLE CUBE shape.
def	man
	Create a curve with a MAN shape.
def	null
	Create a curve with a NULL shape.
def	getPointArrayWithOffset
	Convert a list of vector to a List of Double and add the position and rotation offset.

---

Detailed Description

    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::icon::primOrIcon	(		prim,
			parent,
			name,
			t,
			color,
			icon,
			kwargs
	)

Create a icon or a primitive form primitive definition.

Parameters:

	prim	PrimitiveDefinition - None to skip
	parent	X3DObject - Parent of the newly created object
	name	String - Name of the newly created object
	t	SITransformation - Transformation of the newly created object
	color	List of Float - Color of the newly created object in RGB
	icon	String - Icon type in case prim is not define
	kwargs	- Argument to create the icon

Returns:

X3DObject

def gear::xsi::icon::cube	(		parent = xsi.ActiveSceneRoot,
			name = "cube",
			width = 1,
			height = 1,
			depth = 1,
			color = [0,
			t = XSIMath.CreateTransform(),
			pos_offset = XSIMath.CreateVector3(),
			rot_offset = XSIMath.CreateRotation()
	)

Create a curve with a CUBE shape.

Parameters:

	parent	X3DObject - The parent object of the newly created curve.
	name	String - Name of the curve.
	width	Double - Width of the shape.
	height	Double - Height of the shape.
	depth	Double - Depth of the shape.
	color	List of Double - RGB color of the curve.
	t	SITransform - The global transformation of the curve.
	pos_offset	SIVector3 - The position offset of the curve from its center.
	rot_offset	SIRotation - The rotation offset of the curve from its center.

def gear::xsi::icon::pyramid	(		parent = xsi.ActiveSceneRoot,
			name = "pyramid",
			width = 1,
			height = 1,
			depth = 1,
			color = [0,
			t = XSIMath.CreateTransform(),
			pos_offset = XSIMath.CreateVector3(),
			rot_offset = XSIMath.CreateRotation()
	)

Create a curve with a PYRAMIDE shape.

Parameters:

	parent	X3DObject - The parent object of the newly created curve.
	name	String - Name of the curve.
	width	Double - Width of the shape.
	height	Double - Height of the shape.
	depth	Double - Depth of the shape.
	color	List of Double - RGB color of the curve.
	t	SITransform - The global transformation of the curve.
	pos_offset	SIVector3 - The position offset of the curve from its center.
	rot_offset	SIRotation - The rotation offset of the curve from its center.

def gear::xsi::icon::square	(		parent = xsi.ActiveSceneRoot,
			name = "square",
			width = 1,
			depth = 1,
			color = [0,
			t = XSIMath.CreateTransform(),
			pos_offset = XSIMath.CreateVector3(),
			rot_offset = XSIMath.CreateRotation()
	)

Create a curve with a SQUARE shape.

Parameters:

	parent	X3DObject - The parent object of the newly created curve.
	name	String - Name of the curve.
	width	Double - Width of the shape.
	depth	Double - Depth of the shape.
	color	List of Double - RGB color of the curve.
	t	SITransform - The global transformation of the curve.
	pos_offset	SIVector3 - The position offset of the curve from its center.
	rot_offset	SIRotation - The rotation offset of the curve from its center.

def gear::xsi::icon::flower	(		parent = xsi.ActiveSceneRoot,
			name = "flower",
			width = 1,
			color = [0,
			t = XSIMath.CreateTransform(),
			pos_offset = XSIMath.CreateVector3(),
			rot_offset = XSIMath.CreateRotation()
	)

Create a curve with a FLOWER shape.

Parameters:

	parent	X3DObject - The parent object of the newly created curve.
	name	String - Name of the curve.
	width	Double - Width of the shape.
	color	List of Double - RGB color of the curve.
	t	SITransform - The global transformation of the curve.
	pos_offset	SIVector3 - The position offset of the curve from its center.
	rot_offset	SIRotation - The rotation offset of the curve from its center.

def gear::xsi::icon::circle	(		parent = xsi.ActiveSceneRoot,
			name = "circle",
			width = 1,
			color = [0,
			t = XSIMath.CreateTransform(),
			pos_offset = XSIMath.CreateVector3(),
			rot_offset = XSIMath.CreateRotation()
	)

Create a curve with a CIRCLE shape.

Parameters:

	parent	X3DObject - The parent object of the newly created curve.
	name	String - Name of the curve.
	width	Double - Width of the shape.
	color	List of Double - RGB color of the curve.
	t	SITransform - The global transformation of the curve.
	pos_offset	SIVector3 - The position offset of the curve from its center.
	rot_offset	SIRotation - The rotation offset of the curve from its center.

def gear::xsi::icon::cylinder	(		parent = xsi.ActiveSceneRoot,
			name = "cylinder",
			width = 1,
			heigth = 1,
			color = [0,
			t = XSIMath.CreateTransform(),
			pos_offset = XSIMath.CreateVector3(),
			rot_offset = XSIMath.CreateRotation()
	)

Create a curve with a CYLINDER shape.

Parameters:

	parent	X3DObject - The parent object of the newly created curve.
	name	String - Name of the curve.
	width	Double - Width of the shape.
	color	List of Double - RGB color of the curve.
	t	SITransform - The global transformation of the curve.
	pos_offset	SIVector3 - The position offset of the curve from its center.
	rot_offset	SIRotation - The rotation offset of the curve from its center.

def gear::xsi::icon::compas	(		parent = xsi.ActiveSceneRoot,
			name = "compas",
			width = 1,
			color = [0,
			t = XSIMath.CreateTransform(),
			pos_offset = XSIMath.CreateVector3(),
			rot_offset = XSIMath.CreateRotation()
	)

Create a curve with a COMPAS shape.

Parameters:

	parent	X3DObject - The parent object of the newly created curve.
	name	String - Name of the curve.
	width	Double - Width of the shape.
	color	List of Double - RGB color of the curve.
	t	SITransform - The global transformation of the curve.
	pos_offset	SIVector3 - The position offset of the curve from its center.
	rot_offset	SIRotation - The rotation offset of the curve from its center.

def gear::xsi::icon::foil	(		parent = xsi.ActiveSceneRoot,
			name = "foil",
			width = 1,
			length = 1,
			color = [0,
			t = XSIMath.CreateTransform(),
			pos_offset = XSIMath.CreateVector3(),
			rot_offset = XSIMath.CreateRotation()
	)

Create a curve with a FOIL shape.

Parameters:

	parent	X3DObject - The parent object of the newly created curve.
	name	String - Name of the curve.
	width	Double - Width of the shape.
	length	Double - Length of the shape.
	color	List of Double - RGB color of the curve.
	t	SITransform - The global transformation of the curve.
	pos_offset	SIVector3 - The position offset of the curve from its center.
	rot_offset	SIRotation - The rotation offset of the curve from its center.

def gear::xsi::icon::diamond	(		parent = xsi.ActiveSceneRoot,
			name = "diamond",
			width = 1,
			color = [0,
			t = XSIMath.CreateTransform(),
			pos_offset = XSIMath.CreateVector3(),
			rot_offset = XSIMath.CreateRotation()
	)

Create a curve with a DIAMOND shape.

Parameters:

	parent	X3DObject - The parent object of the newly created curve.
	name	String - Name of the curve.
	width	Double - Width of the shape.
	color	List of Double - RGB color of the curve.
	t	SITransform - The global transformation of the curve.
	pos_offset	SIVector3 - The position offset of the curve from its center.
	rot_offset	SIRotation - The rotation offset of the curve from its center.

def gear::xsi::icon::leash	(		parent = xsi.ActiveSceneRoot,
			name = "leash",
			width = 1,
			attachedPos = XSIMath.CreateVector3(),
			color = [0,
			t = XSIMath.CreateTransform(),
			pos_offset = XSIMath.CreateVector3(),
			rot_offset = XSIMath.CreateRotation()
	)

Create a curve with a LEASH shape.

Parameters:

	parent	X3DObject - The parent object of the newly created curve.
	name	String - Name of the curve.
	width	Double - Width of the shape.
	attachedPos	SIVector3 - Position of the end of the leash.
	color	List of Double - RGB color of the curve.
	t	SITransform - The global transformation of the curve.
	pos_offset	SIVector3 - The position offset of the curve from its center.
	rot_offset	SIRotation - The rotation offset of the curve from its center.

def gear::xsi::icon::cubewithpeak	(		parent = xsi.ActiveSceneRoot,
			name = "cubewithpeak",
			width = 1,
			color = [0,
			t = XSIMath.CreateTransform(),
			pos_offset = XSIMath.CreateVector3(),
			rot_offset = XSIMath.CreateRotation()
	)

Create a curve with a CUBE WITH PEAK shape.

Parameters:

	parent	X3DObject - The parent object of the newly created curve.
	name	String - Name of the curve.
	width	Double - Width of the shape.
	color	List of Double - RGB color of the curve.
	t	SITransform - The global transformation of the curve.
	pos_offset	SIVector3 - The position offset of the curve from its center.
	rot_offset	SIRotation - The rotation offset of the curve from its center.

def gear::xsi::icon::sphere	(		parent = xsi.ActiveSceneRoot,
			name = "sphere",
			width = 1,
			color = [0,
			t = XSIMath.CreateTransform(),
			pos_offset = XSIMath.CreateVector3(),
			rot_offset = XSIMath.CreateRotation()
	)

Create a curve with a SPHERE shape.

Parameters:

	parent	X3DObject - The parent object of the newly created curve.
	name	String - Name of the curve.
	width	Double - Width of the shape.
	color	List of Double - RGB color of the curve.
	t	SITransform - The global transformation of the curve.
	pos_offset	SIVector3 - The position offset of the curve from its center.
	rot_offset	SIRotation - The rotation offset of the curve from its center.

def gear::xsi::icon::arrow	(		parent = xsi.ActiveSceneRoot,
			name = "arrow",
			width = 1,
			color = [0,
			t = XSIMath.CreateTransform(),
			pos_offset = XSIMath.CreateVector3(),
			rot_offset = XSIMath.CreateRotation()
	)

Create a curve with a ARROW shape.

Parameters:

	parent	X3DObject - The parent object of the newly created curve.
	name	String - Name of the curve.
	width	Double - Width of the shape.
	color	List of Double - RGB color of the curve.
	t	SITransform - The global transformation of the curve.
	pos_offset	SIVector3 - The position offset of the curve from its center.
	rot_offset	SIRotation - The rotation offset of the curve from its center.

def gear::xsi::icon::crossarrow	(		parent = xsi.ActiveSceneRoot,
			name = "crossArrow",
			width = 1,
			color = [0,
			t = XSIMath.CreateTransform(),
			pos_offset = XSIMath.CreateVector3(),
			rot_offset = XSIMath.CreateRotation()
	)

Create a curve with a CROSS ARROW shape.

Parameters:

	parent	X3DObject - The parent object of the newly created curve.
	name	String - Name of the curve.
	width	Double - Width of the shape.
	color	List of Double - RGB color of the curve.
	t	SITransform - The global transformation of the curve.
	pos_offset	SIVector3 - The position offset of the curve from its center.
	rot_offset	SIRotation - The rotation offset of the curve from its center.

def gear::xsi::icon::bendedarrow	(		parent = xsi.ActiveSceneRoot,
			name = "bendedArrow",
			width = 1,
			color = [0,
			t = XSIMath.CreateTransform(),
			pos_offset = XSIMath.CreateVector3(),
			rot_offset = XSIMath.CreateRotation()
	)

Create a curve with a BENDED ARROW shape.

Parameters:

	parent	X3DObject - The parent object of the newly created curve.
	name	String - Name of the curve.
	width	Double - Width of the shape.
	color	List of Double - RGB color of the curve.
	t	SITransform - The global transformation of the curve.
	pos_offset	SIVector3 - The position offset of the curve from its center.
	rot_offset	SIRotation - The rotation offset of the curve from its center.

def gear::xsi::icon::bendedarrow2	(		parent = xsi.ActiveSceneRoot,
			name = "bendedArrow2",
			width = 1,
			color = [0,
			t = XSIMath.CreateTransform(),
			pos_offset = XSIMath.CreateVector3(),
			rot_offset = XSIMath.CreateRotation()
	)

Create a curve with a BENDED ARROW shape.

Parameters:

	parent	X3DObject - The parent object of the newly created curve.
	name	String - Name of the curve.
	width	Double - Width of the shape.
	color	List of Double - RGB color of the curve.
	t	SITransform - The global transformation of the curve.
	pos_offset	SIVector3 - The position offset of the curve from its center.
	rot_offset	SIRotation - The rotation offset of the curve from its center.

def gear::xsi::icon::cross	(		parent = xsi.ActiveSceneRoot,
			name = "cross",
			width = 1,
			color = [0,
			t = XSIMath.CreateTransform(),
			pos_offset = XSIMath.CreateVector3(),
			rot_offset = XSIMath.CreateRotation()
	)

Create a curve with a CROSS shape.

Parameters:

	parent	X3DObject - The parent object of the newly created curve.
	name	String - Name of the curve.
	width	Double - Width of the shape.
	color	List of Double - RGB color of the curve.
	t	SITransform - The global transformation of the curve.
	pos_offset	SIVector3 - The position offset of the curve from its center.
	rot_offset	SIRotation - The rotation offset of the curve from its center.

def gear::xsi::icon::glasses	(		parent = xsi.ActiveSceneRoot,
			name = "glasses",
			width = 1,
			color = [0,
			t = XSIMath.CreateTransform(),
			pos_offset = XSIMath.CreateVector3(),
			rot_offset = XSIMath.CreateRotation()
	)

Create a curve with GLASSES shape.

Parameters:

	parent	X3DObject - The parent object of the newly created curve.
	name	String - Name of the curve.
	width	Double - Width of the shape.
	color	List of Double - RGB color of the curve.
	t	SITransform - The global transformation of the curve.
	pos_offset	SIVector3 - The position offset of the curve from its center.
	rot_offset	SIRotation - The rotation offset of the curve from its center.

def gear::xsi::icon::lookat	(		parent = xsi.ActiveSceneRoot,
			name = "lookat",
			width = 1,
			color = [0,
			t = XSIMath.CreateTransform(),
			pos_offset = XSIMath.CreateVector3(),
			rot_offset = XSIMath.CreateRotation()
	)

Create a curve with a LOOKAT shape.

Parameters:

	parent	X3DObject - The parent object of the newly created curve.
	name	String - Name of the curve.
	width	Double - Width of the shape.
	color	List of Double - RGB color of the curve.
	t	SITransform - The global transformation of the curve.
	pos_offset	SIVector3 - The position offset of the curve from its center.
	rot_offset	SIRotation - The rotation offset of the curve from its center.

def gear::xsi::icon::eyearrow	(		parent = xsi.ActiveSceneRoot,
			name = "eyeArrow",
			width = 1,
			color = [0,
			t = XSIMath.CreateTransform(),
			pos_offset = XSIMath.CreateVector3(),
			rot_offset = XSIMath.CreateRotation()
	)

Create a curve with a EYE ARROW shape.

Parameters:

	parent	X3DObject - The parent object of the newly created curve.
	name	String - Name of the curve.
	width	Double - Width of the shape.
	color	List of Double - RGB color of the curve.
	t	SITransform - The global transformation of the curve.
	pos_offset	SIVector3 - The position offset of the curve from its center.
	rot_offset	SIRotation - The rotation offset of the curve from its center.

def gear::xsi::icon::anglesurvey	(		parent = xsi.ActiveSceneRoot,
			name = "angleSurvey",
			width = 1,
			color = [0,
			t = XSIMath.CreateTransform(),
			pos_offset = XSIMath.CreateVector3(),
			rot_offset = XSIMath.CreateRotation()
	)

Create a curve with a ANGLE SURVEY shape.

Parameters:

	parent	X3DObject - The parent object of the newly created curve.
	name	String - Name of the curve.
	width	Double - Width of the shape.
	color	List of Double - RGB color of the curve.
	t	SITransform - The global transformation of the curve.
	pos_offset	SIVector3 - The position offset of the curve from its center.
	rot_offset	SIRotation - The rotation offset of the curve from its center.

def gear::xsi::icon::eyeball	(		parent = xsi.ActiveSceneRoot,
			name = "eyeBall",
			width = 1,
			color = [0,
			t = XSIMath.CreateTransform(),
			pos_offset = XSIMath.CreateVector3(),
			rot_offset = XSIMath.CreateRotation()
	)

Create a curve with a EYE BALL shape.

Parameters:

	parent	X3DObject - The parent object of the newly created curve.
	name	String - Name of the curve.
	width	Double - Width of the shape.
	color	List of Double - RGB color of the curve.
	t	SITransform - The global transformation of the curve.
	pos_offset	SIVector3 - The position offset of the curve from its center.
	rot_offset	SIRotation - The rotation offset of the curve from its center.

def gear::xsi::icon::rectanglecube	(		parent = xsi.ActiveSceneRoot,
			name = "rectangleCube",
			width = 1,
			color = [0,
			t = XSIMath.CreateTransform(),
			pos_offset = XSIMath.CreateVector3(),
			rot_offset = XSIMath.CreateRotation()
	)

Create a curve with a RECTANGLE CUBE shape.

Parameters:

	parent	X3DObject - The parent object of the newly created curve.
	name	String - Name of the curve.
	width	Double - Width of the shape.
	color	List of Double - RGB color of the curve.
	t	SITransform - The global transformation of the curve.
	pos_offset	SIVector3 - The position offset of the curve from its center.
	rot_offset	SIRotation - The rotation offset of the curve from its center.

def gear::xsi::icon::man	(		parent = xsi.ActiveSceneRoot,
			name = "man",
			width = 1,
			color = [0,
			t = XSIMath.CreateTransform(),
			pos_offset = XSIMath.CreateVector3(),
			rot_offset = XSIMath.CreateRotation()
	)

Create a curve with a MAN shape.

Parameters:

	parent	X3DObject - The parent object of the newly created curve.
	name	String - Name of the curve.
	width	Double - Width of the shape.
	color	List of Double - RGB color of the curve.
	t	SITransform - The global transformation of the curve.
	pos_offset	SIVector3 - The position offset of the curve from its center.
	rot_offset	SIRotation - The rotation offset of the curve from its center.

def gear::xsi::icon::null	(		parent = xsi.ActiveSceneRoot,
			name = "null",
			width = 1,
			color = [0,
			t = XSIMath.CreateTransform(),
			pos_offset = XSIMath.CreateVector3(),
			rot_offset = XSIMath.CreateRotation()
	)

Create a curve with a NULL shape.

Parameters:

	parent	X3DObject - The parent object of the newly created curve.
	name	String - Name of the curve.
	width	Double - Width of the shape.
	color	List of Double - RGB color of the curve.
	t	SITransform - The global transformation of the curve.
	pos_offset	SIVector3 - The position offset of the curve from its center.
	rot_offset	SIRotation - The rotation offset of the curve from its center.

def gear::xsi::icon::getPointArrayWithOffset	(		point_pos,
			pos_offset,
			rot_offset
	)

Convert a list of vector to a List of Double and add the position and rotation offset.

Parameters:

	point_pos	List of SIVector3 - The point position.
	pos_offset	SIVector3 - The position offset of the curve from its center.
	rot_offset	SIRotation - The rotation offset of the curve from its center.