VUEBasicObject Class Reference

Your Ad Here

List of all members.

Public Types
enum	EVueObjectType {   VOT_BoundingVolume, VOT_InfinitePlane, VOT_Plane, VOT_Cylinder,   VOT_Sphere, VOT_Cube, VOT_Cone, VOT_Pyramid,   VOT_Terrain, VOT_Mesh, VOT_Plant, VOT_CSGUnion,   VOT_CSGIntersection, VOT_CSGDifference, VOT_Group, Reserved0,   Reserved1, VOT_DirectionLight, VOT_PointLight, VOT_SpotLight,   Reserved2, VOT_Camera, VOT_Torus, VOT_PointLight2,   VOT_SpotLight2, VOT_AlphaPlane, VOT_Planet, VOT_SymmetricalTerrain,   VOT_Stone, Reserved3, VOT_PythonObject, VOT_ParametricTerrain,   Reserved4, Reserved5, Reserved6, VOT_Reference,   VOT_ReferenceGroup, VOT_EcosystemInstanceProxy, VOT_Fan, VOT_Vegetation,   VOT_AreaLight, VOT_VolumeCloud, VOT_MeshObject, VOT_SubdivMeshObject,   VOT_BakedSubdivMesh, VOT_PlantSubdivMesh, VOT_MultiBakedMesh }
Public Member Functions
int	CountMaterials ()
	Returns the number of materials assigned to this object.
EDisplayQuality	DisplayQuality ()
	Returns the draw quality used for the OpenGL previewing of the object in the viewports.
VUEAggregate	GetAggregate ()
	Returns a VUEAggregate object if this object is actually a VUEAggregate else return None (a VUEAggregate may be a group or a boolean operation).
int	GetLayer ()
	Returns the number of the layer that the object belongs to.
VUEBasicObject	GetLinkParent ()
	Returns the object that this object is linked to, or None if this object is not linked.
tuple_of_floats_x_y_z	GetRotationAngles ()
	Gets the rotation angles of the object.
tuple_of_floats_x_y_z	GetScale ()
	Gets the scale of the object.
VUEBasicObject	GetTrackParent ()
	Returns the object that is being tracked by this object, or None if no object is tracked.
array_of_floats	GetTransformation ()
	Gets the matrix transformation.
boolean	IsAutoPreviewColor ()
	Returns true if the preview color of the object reflects the average color of the material that is assigned to it.
boolean	IsBooleanOperation ()
	Returns true if the object is a Boolean operation.
boolean	IsCamera ()
	Returns true if the object is a camera.
boolean	IsCloud ()
	Returns true if the object is a volume cloud object.
boolean	IsFan ()
	Returns true if the object is a fan object.
boolean	IsGroup ()
	Returns true if the object is a group of objects.
boolean	IsHidden ()
	Returns true if the object is hidden.
boolean	IsInfinitePlane ()
	Returns true if the object is an infinite plane.
boolean	IsLight ()
	Returns true if the object is a light.
boolean	IsLinkedOrTracks (VUEBasicObject pLinkOrTrackObject=None)
	Checks if the object is linked or is tracking the object passed as argument.
boolean	IsLinkedTo (VUEBasicObject pLinkedToObject=None)
	Checks if the object is linked to the object passed as argument.
boolean	IsLocked ()
	Returns true if the object is locked.
boolean	IsMesh ()
	Returns true if the object is a polygon mesh.
boolean	IsMetaball ()
	Returns true if the object is a metaball object.
boolean	IsPlanet ()
	Returns true if the object is a planet.
boolean	IsPlant ()
	Returns true if the object is a plant.
boolean	IsPrimitive ()
	Returns true if the object is a primitive (e.g. Cube, Sphere, Cone, Torus...).
boolean	IsPythonObject ()
	Returns true if the object is a python object.
boolean	IsSelected ()
	Returns true if the object is selected.
boolean	IsTarget ()
	Returns true if the object is a target.
boolean	IsTerrain ()
	Returns true if the object is a terrain (or a symmetrical terrain).
boolean	IsTracking (VUEBasicObject pTrackingObject=None)
	Checks if the object is tracking the object passed as argument.
VUEMaterial	Material (int nIndexInMatList)
	Returns the material assigned to the object.
int	MaterialIndex (int nIndexInMatList)
	Returns the index of the material assigned to the object in the list of materials of the scene.
str	MaterialName (int nIndexInMatList)
	Returns the name of the material assigned to the object.
None	Move (float x=10, float y=10, float z=10)
	Moves the object along the world's X, Y and Z axes.
None	MoveV (tuple_of_floats_x_y_z vTranslate)
	Moves the object using a vector.
str	Name ()
	Returns the name of the object.
tuple_of_floats_x_y_z	Position ()
	Returns the position of the object in world coordinates.
EPreviewColor	PreviewColor ()
	Returns the color used for previewing the object in the viewports.
tuple_of_ints_r_g_b	RayTrace (tuple_of_floats_x_y_z vPos, tuple_of_floats_x_y_z vDir, float fDist, boolean bIsShadowRay)
	Trace a ray through scene.
None	Resize (float fScalingRatio=2)
	Changes the size of the object uniformly.
None	ResizeAxis (float x, float y, float z, boolean bScaleInObjectSpace=false)
	Changes the size of the object with differentiated scaling ratios along the world's X, Y and Z axes.
None	ResizeAxisV (tuple_of_floats_x_y_z vScale, boolean bScaleInObjectSpace=false)
	Changes the size of the object with differentiated scaling ratios along the world's X, Y and Z axes, using a vector.
None	Rotate (float x=0, float y=0, float z=15, boolean bRotateInObjectSpace=false)
	Rotates the object around the X, Y and Z axes.
None	RotateV (tuple_of_floats_x_y_z vAngles, boolean bRotateInObjectSpace=false)
	Rotates the object around the X, Y and Z axes, using a vector.
None	SetDisplayQuality (EDisplayQuality eNewQuality)
	Sets the draw quality used for the OpenGL previewing of the object in the viewports.
boolean	SetImpactAspectCallback (function fptrPythonImpactAspectCallback=None)
	Sets a callback method that will be called each time the object is hit, for impact color and transparency.
boolean	SetInitFrameCallback (function fptrPythonInitFrameCallback=None)
	Sets a callback method that will be called each time the rendering of a new frame of the object begins.
None	SetLinkFlags (boolean bLinkPosition=true, boolean bLinkRotation=true, boolean bLinkSize=true, boolean bLinkTwist=true)
	Sets the type of linking between this object and the object it is linked to.
None	SetLinkParent (VUEBasicObject pNewLinkParent=None)
	Sets the object that this object will be linked to.
boolean	SetMaterial (str cszMaterialName="Default", int nIndexInMatList=0)
	Changes the material of the object.
boolean	SetMaterialIndex (int nMaterialIndex, int nIndexInMatList)
	Changes the material of the object to the material of the indicated index.
None	SetName (str cszNewName)
	Changes the name of the object.
None	SetPivotPosition (float x=0, float y=0, float z=0)
	Moves the object's pivot point along the world's X, Y and Z axes.
None	SetPosition (float x=0, float y=0, float z=0)
	Moves the object to a given location in world coordinates.
None	SetPositionV (tuple_of_floats_x_y_z vPosition)
	Moves the object to a given location in world coordinates, using a vector.
None	SetPreviewColor (EPreviewColor eNewColor)
	Sets the color used for previewing the object in the viewports.
None	SetRotationAngles (float x=0, float y=0, float z=0, boolean bRotateInObjectSpace=false)
	Rotates the object to a given orientation around the X, Y and Z axes.
None	SetRotationAnglesV (tuple_of_floats_x_y_z vAngles, boolean bRotateInObjectSpace=false)
	Rotates the object to a given orientation around the X, Y and Z axes, using a vector.
None	SetTrackParent (VUEBasicObject pNewTrackParent=None)
	Sets the object that this object will be tracking.
None	SetTransformation (array_of_floats transformation)
	Sets the matrix transformation.
boolean	SetVolumetricDensityCallback (function fptrPythonVolumetricDensityCallback=None)
	Sets a callback method that will be called each time Vue needs to integrate volumetric density through the object.
VUEBakedSubdivMesh	ToBakedSubdivMesh ()
	Returns a VUEBakedSubdivMesh object if this object is actually a VUEBakedSubdivMesh else return None.
VUECSG	ToBooleanOperation ()
	Returns a VUECSG object if this object is actually a VUECSG (a boolean operation) else return None.
VUECamera	ToCamera ()
	Returns a VUECamera object if this object is actually a VUECamera else return None.
VUEAggregate	ToGroup ()
	Returns a VUEAggregate object if this object is actually a VUEGroup else return None.
VUEInfinitePlane	ToInfinitePlane ()
	Returns a VUEInfinitePlane object if this object is actually a VUEInfinitePlane else return None.
VUELight	ToLight ()
	Returns a VUELight object if this object is actually a VUELight else return None.
VUEMeshObject	ToMeshObject ()
	Returns a VUEMeshObject object if this object is actually a VUEMeshObject else return None.
VUEPlanet	ToPlanet ()
	Returns a VUEPlanet object if this object is actually a VUEPlanet else return None.
VUEPlant	ToPlant ()
	Returns a VUEPlant object if this object is actually a VUEPlant else return None.
VUEPreanimatedGroup	ToPreanimatedGroup ()
	Returns a VUEPreanimatedGroup object if this object is actually a VUEPreanimatedGroup else return None.
VUEBasicObject	ToPrimitive ()
	Returns the VUEBasicObject object version of this object if this object is a primitive (e.g. Cube, Sphere, Cone, Torus...) else return None.
VUEPythonObject	ToPythonObject ()
	Returns a VUEPythonObject object if this object is actually a VUEPythonObject else return None.
VUESubdivMeshObject	ToSubdivMesh ()
	Returns a VUESubdivMeshObject object if this object is actually a VUESubdivMeshObject else return None.
VUETarget	ToTarget ()
	Returns a VUETarget object if this object is actually a VUETarget else return None. (VUETarget class: dummy object used by camera : distance between the former and the latter gives the focus distance involved in depth of field).
VUETerrain	ToTerrain ()
	Returns a VUETerrain object if this object is actually a VUETerrain else return None.
VUETorus	ToTorus ()
	Returns a VUETorus object if this object is actually a VUETorus else return None.
None	Twist (float fZtoY=0, float fZtoX=0, float fYtoX=15)
	Twists the object.
EVueObjectType	Type ()
	Returns the type of the object. See EVueObjectType for possible values.

---

Member Enumeration Documentation

enum EVueObjectType

Enumeration values: VOT_BoundingVolume  Reserved. VOT_InfinitePlane  Identifies an infinite plane. VOT_Plane  Identifies a plane (do not confuse with infinite plane above. VOT_Cylinder  Identifies a cylinder. VOT_Sphere  Identifies a sphere. VOT_Cube  Identifies a cube. VOT_Cone  Identifies a cone. VOT_Pyramid  Identifies a pyramid. VOT_Terrain  Identifies a terrain. VOT_Mesh  Identifies a 3D polygon mesh (imported object). VOT_Plant  Identifies a plant. VOT_CSGUnion  Identifies a Boolean union. VOT_CSGIntersection  Identifies a Boolean intersection. VOT_CSGDifference  Identifies a Boolean difference. VOT_Group  Identifies a group. Reserved0  Reserved for future use. Reserved1  Reserved for future use. VOT_DirectionLight  Identifies a directional light (sun light). VOT_PointLight  Identifies a point light (omni light) with linear decay. VOT_SpotLight  Identifies a spot light with linear decay. Reserved2  Reserved for future use. VOT_Camera  Identifies a camera. VOT_Torus  Identifies a torus. VOT_PointLight2  Identifies a point light (omni light) with quadratic decay. VOT_SpotLight2  Identifies a spot light with quadratic decay. VOT_AlphaPlane  Identifies an alpha plane. VOT_Planet  Identifies a planet. VOT_SymmetricalTerrain  Identifies a symmetrical terrain. VOT_Stone  Identifies a stone. Reserved3  Identifies a 3D text mesh. VOT_PythonObject  Identifies a python object. VOT_ParametricTerrain  Identifies a parametric terrain. Reserved4  Identifies an Animated mesh. Reserved5  Identifies an Animated mesh part. Reserved6  Identifies a poser hair (belong to an Animated group). VOT_Reference  Identifies a reference. VOT_ReferenceGroup  Identifies a reference group. VOT_EcosystemInstanceProxy  Identifies an ecosystem instance proxy. VOT_Fan  Identifies a fan. VOT_Vegetation  Identifies a vegetation. VOT_AreaLight  Identifies an area light (defined by a solid object). VOT_VolumeCloud  Identifies a volume cloud object. VOT_MeshObject  Identifies a 3D polygon mesh (imported object). VOT_SubdivMeshObject  Identifies a subdividable 3D polygon mesh [internal]. VOT_BakedSubdivMesh  Identifies a baked subdivision mesh [internal]. VOT_PlantSubdivMesh  Identifies a displaced plant object [internal]. VOT_MultiBakedMesh  Identifies a set of baked subdivision meshes.

---

Member Function Documentation

int CountMaterials (   )

Returns the number of materials assigned to this object.

EDisplayQuality DisplayQuality (   )

Returns the draw quality used for the OpenGL previewing of the object in the viewports. See also: EDisplayQuality, SetDisplayQuality.

VUEAggregate GetAggregate (   )

Returns a VUEAggregate object if this object is actually a VUEAggregate else return None (a VUEAggregate may be a group or a boolean operation).

int GetLayer (   )

Returns the number of the layer that the object belongs to.

VUEBasicObject GetLinkParent (   )

Returns the object that this object is linked to, or None if this object is not linked.

tuple_of_floats_x_y_z GetRotationAngles (   )

Gets the rotation angles of the object. Returns: The current rotation angles of the object (x axis, y axis, z axis). See also: Rotate, SetRotationAngles.

tuple_of_floats_x_y_z GetScale (   )

Gets the scale of the object. Returns: The current scale vector of the object (x, y, z). See also: Resize, ResizeAxis.

VUEBasicObject GetTrackParent (   )

Returns the object that is being tracked by this object, or None if no object is tracked.

array_of_floats GetTransformation (   )

Gets the matrix transformation. Returns: The current 3x3 transformation matrix of the object. See also: SetTransformation.

boolean IsAutoPreviewColor (   )

Returns true if the preview color of the object reflects the average color of the material that is assigned to it. See also: PreviewColor.

boolean IsBooleanOperation (   )

Returns true if the object is a Boolean operation. See also: IsLight, IsPrimitive, IsMesh, IsGroup, IsCamera, IsBooleanOperation, IsInfinitePlane, IsTerrain, IsPlant, IsPlanet.

boolean IsCamera (   )

Returns true if the object is a camera. See also: IsLight, IsPrimitive, IsMesh, IsGroup, IsCamera, IsBooleanOperation, IsInfinitePlane, IsTerrain, IsPlant, IsPlanet.

boolean IsCloud (   )

Returns true if the object is a volume cloud object. See also: IsLight, IsPrimitive, IsMesh, IsGroup, IsCamera, IsBooleanOperation, IsInfinitePlane, IsTerrain, IsPlant, IsPlanet.

boolean IsFan (   )

Returns true if the object is a fan object. See also: IsLight, IsPrimitive, IsMesh, IsGroup, IsCamera, IsBooleanOperation, IsInfinitePlane, IsTerrain, IsPlant, IsPlanet.

boolean IsGroup (   )

Returns true if the object is a group of objects. See also: IsLight, IsPrimitive, IsMesh, IsGroup, IsCamera, IsBooleanOperation, IsInfinitePlane, IsTerrain, IsPlant, IsPlanet.

boolean IsHidden (   )

Returns true if the object is hidden.

boolean IsInfinitePlane (   )

Returns true if the object is an infinite plane. See also: IsLight, IsPrimitive, IsMesh, IsGroup, IsCamera, IsBooleanOperation, IsInfinitePlane, IsTerrain, IsPlant, IsPlanet.

boolean IsLight (   )

Returns true if the object is a light. See also: IsLight, IsPrimitive, IsMesh, IsGroup, IsCamera, IsBooleanOperation, IsInfinitePlane, IsTerrain, IsPlant, IsPlanet.

boolean IsLinkedOrTracks (  VUEBasicObject  pLinkOrTrackObject = None  )

Checks if the object is linked or is tracking the object passed as argument. param pLinkOrTrackObject identifies the object will be tested. Returns: True if the object is linked to or tracking pLinkOrTrackObject. If pLinkOrTrackObject is not indicated, returns true if the object is linked or is tracking an object in the scene, false if it isn't linked or tracking anything. See also: IsLinkedOrTracks.

boolean IsLinkedTo (  VUEBasicObject  pLinkedToObject = None  )

Checks if the object is linked to the object passed as argument. param pLinkedToObject identifies the object that the link will be tested against. Returns: True if the object is linked to pLinkedToObject. If pLinkedToObject is not indicated, returns true if the object is linked to any other object in the scene, false if it isn't linked to anything. See also: IsLinkedOrTracks.

boolean IsLocked (   )

Returns true if the object is locked.

boolean IsMesh (   )

Returns true if the object is a polygon mesh. See also: IsLight, IsPrimitive, IsMesh, IsGroup, IsCamera, IsBooleanOperation, IsInfinitePlane, IsTerrain, IsPlant, IsPlanet.

boolean IsMetaball (   )

Returns true if the object is a metaball object. See also: IsLight, IsPrimitive, IsMesh, IsGroup, IsCamera, IsBooleanOperation, IsInfinitePlane, IsTerrain, IsPlant, IsPlanet.

boolean IsPlanet (   )

Returns true if the object is a planet. See also: IsLight, IsPrimitive, IsMesh, IsGroup, IsCamera, IsBooleanOperation, IsInfinitePlane, IsTerrain, IsPlant, IsPlanet.

boolean IsPlant (   )

Returns true if the object is a plant. See also: IsLight, IsPrimitive, IsMesh, IsGroup, IsCamera, IsBooleanOperation, IsInfinitePlane, IsTerrain, IsPlant, IsPlanet.

boolean IsPrimitive (   )

Returns true if the object is a primitive (e.g. Cube, Sphere, Cone, Torus...). See also: IsLight, IsPrimitive, IsMesh, IsGroup, IsCamera, IsBooleanOperation, IsInfinitePlane, IsTerrain, IsPlant, IsPlanet.

boolean IsPythonObject (   )

Returns true if the object is a python object. See also: IsLight, IsPrimitive, IsMesh, IsGroup, IsCamera, IsBooleanOperation, IsInfinitePlane, IsTerrain, IsPlant, IsPlanet.

boolean IsSelected (   )

Returns true if the object is selected.

boolean IsTarget (   )

Returns true if the object is a target. See also: IsLight, IsPrimitive, IsMesh, IsGroup, IsCamera, IsBooleanOperation, IsInfinitePlane, IsTerrain, IsPlant, IsPlanet.

boolean IsTerrain (   )

Returns true if the object is a terrain (or a symmetrical terrain). See also: IsLight, IsPrimitive, IsMesh, IsGroup, IsCamera, IsBooleanOperation, IsInfinitePlane, IsTerrain, IsPlant, IsPlanet.

boolean IsTracking (  VUEBasicObject  pTrackingObject = None  )

Checks if the object is tracking the object passed as argument. param pTrackingObject identifies the object that the track will be tested against. Returns: True if the object is tracking pTrackingObject. If pTrackingObject is not indicated, returns true if the object is tracking an object in the scene, false if it isn't tracking anything. See also: IsLinkedOrTracks.

VUEMaterial Material (  int  nIndexInMatList  )

Returns the material assigned to the object. Parameters: nIndexInMatList  Index in the internal materials list of the object (between 0 and CountMaterials()-1) Warning: Persistence of the material is not guaranteed. Other operations may result in the destruction of the material. You should use the material immediately after calling this function. Storing it for future use may result in errors. See also: SetMaterial, SetMaterialIndex, MaterialName, MaterialIndex

int MaterialIndex (  int  nIndexInMatList  )

Returns the index of the material assigned to the object in the list of materials of the scene. Parameters: nIndexInMatList  Index in the internal materials list of the object (between 0 and CountMaterials()-1) Warning: Persistence of the material with the returned index is not guaranteed. Other operations may result in the destruction of the material. You should use the material immediately after calling this function. Storing it for future use may result in errors. See also: SetMaterial, SetMaterialIndex, MaterialName, Material

str MaterialName (  int  nIndexInMatList  )

Returns the name of the material assigned to the object. Parameters: nIndexInMatList  Index in the internal materials list of the object (between 0 and CountMaterials()-1) Warning: Persistence of the material with the returned name is not guaranteed. Other operations may result in the destruction of the material. You should use the material immediately after calling this function. Storing it for future use may result in errors. See also: SetMaterial, SetMaterialIndex, MaterialIndex, Material

None Move (  float  x = 10, float  y = 10, float  z = 10 )

Moves the object along the world's X, Y and Z axes. Parameters: x  offset along the X axis. y  offset along the Y axis. z  offset along the Z axis. Remarks: If no parameters are specified, moves the object 10 units along each axis. See also: MoveV, SetPosition, SetPositionV.

None MoveV (  tuple_of_floats_x_y_z  vTranslate  )

Moves the object using a vector. Parameters: vTranslate  vector offset (x, y, z). See also: Move, SetPosition, SetPositionV.

str Name (   )

Returns the name of the object.

tuple_of_floats_x_y_z Position (   )

Returns the position of the object in world coordinates.

EPreviewColor PreviewColor (   )

Returns the color used for previewing the object in the viewports. See also: EPreviewColor, SetPreviewColor, IsautoPreviewColor.

tuple_of_ints_r_g_b RayTrace (  tuple_of_floats_x_y_z  vPos, tuple_of_floats_x_y_z  vDir, float  fDist, boolean  bIsShadowRay )

Trace a ray through scene. Parameters: vPos  is the starting point of the ray. vDir  is the direction vector of the ray. fDist  is the distance range over which intersections should be tested. This should be set to a very high value for eye rays, and to the distance to tested light for shadow rays. bIsShadowRay  is flag which is true (1) when ray is a shadow ray. Remarks: This function allows user to compute raytraced reflection, refraction effects and shadows when using an ImpactaspectCallback python function or a VolumetricDensityCallback python function. The former provides enough information about impact (incoming direction and normal vector) to be able to compute reflected and/or refracted directions. This function should be used ONLY inside your Impactaspect or VolumetricDensity callback functions in order to work properly. Using it elsewhere could cause unexpected results and crashes. Returns: the color (if eye ray) or the color filter (if shadow ray) seen from impact point towards given direction. See also: SetImpactaspectCallback, SetVolumetricDensityCallback.

None Resize (  float  fScalingRatio = 2  )

Changes the size of the object uniformly. Parameters: fScalingRatio  scaling ratio of the object. Remarks: a scaling ratio of 1 leaves the object's size unchanged. 2 doubles the size of the object, while 0.5 halves it. See also: ResizeAxis, GetScale.

None ResizeAxis (  float  x, float  y, float  z, boolean  bScaleInObjectSpace = false )

Changes the size of the object with differentiated scaling ratios along the world's X, Y and Z axes. Parameters: x  scaling ratio along the X axis. y  scaling ratio along the Y axis. z  scaling ratio along the Z axis. bScaleInObjectSpace  if set to true, the object will be scaled along its own axes, rather than the world's axes. Remarks: a scaling ratio of 1 leaves the object's scale unchanged. 2 doubles the size of the object along an axis, while 0.5 halves it. all 3 values must be specified. See also: ResizeAxisV, Resize, GetScale.

None ResizeAxisV (  tuple_of_floats_x_y_z  vScale, boolean  bScaleInObjectSpace = false )

Changes the size of the object with differentiated scaling ratios along the world's X, Y and Z axes, using a vector. Parameters: vScale  scaling ratio along the X, Y and Z axis. bScaleInObjectSpace  if set to true, the object will be scaled along its own axes, rather than the world's axes. Remarks: a scaling ratio of 1 leaves the object's scale unchanged. 2 doubles the size of the object along an axis, while 0.5 halves it. See also: ResizeAxis, Resize, GetScale.

None Rotate (  float  x = 0, float  y = 0, float  z = 15, boolean  bRotateInObjectSpace = false )

Rotates the object around the X, Y and Z axes. Parameters: x  rotation angle in degrees around the X axis. y  rotation angle in degrees around the Y axis. z  rotation angle in degrees around the Z axis. bRotateInObjectSpace  if set to true, the object will be rotated around its own axes, rather than the world's axes. Remarks: If no parameters are specified, rotates the object 15° around the world's Z axis. See also: RotateV, SetRotationAngles, GetRotationAngles.

None RotateV (  tuple_of_floats_x_y_z  vAngles, boolean  bRotateInObjectSpace = false )

Rotates the object around the X, Y and Z axes, using a vector. Parameters: vAngles  rotation angles in degrees around the X, Y and Z axis. bRotateInObjectSpace  if set to true, the object will be rotated around its own axes, rather than the world's axes. See also: Rotate, SetRotationAngles, GetRotationAngles.

None SetDisplayQuality (  EDisplayQuality  eNewQuality  )

Sets the draw quality used for the OpenGL previewing of the object in the viewports. Parameters: eNewQuality  the new quality setting for the object. See also: EDisplayQuality, DisplayQuality.

boolean SetImpactAspectCallback (  function  fptrPythonImpactAspectCallback = None  )

Sets a callback method that will be called each time the object is hit, for impact color and transparency. Parameters: fptrPythonImpactaspectCallback  the python method that will be called each time this object is hit. Remarks: This callback can be used to achieve home made texturing and coloring of your objects. The callback will be called each time Vue will actually detect an impact point in order to determine the latter's attributes. Callback description: The Python callback should accept 12 floats and a bool, and return a tuple of 7 ints (diffuse color, specular color, metallic flag) and 7 floats (transparency, reflectivity, diffuse, luminous, ambiant, specular strength, specular shininess) when ray is not a shadow ray, and 3 ints (shadow color) and a float (transparency) when ray is a shadow ray The callback should look like this: (i, i, i, i, i, i, i, f, f, f, f, f, f, f) ImpactaspectCallback(x_loc, y_loc, z_loc, x_pos, y_pos, z_pos, x_nrm, y_nrm, z_nrm, x_dir, y_dir, z_dir, shadow_ray) for eye rays, (i, i, i, f) ImpactaspectCallback(x_loc, y_loc, z_loc, x_pos, y_pos, z_pos, x_nrm, y_nrm, z_nrm, x_dir, y_dir, z_dir, shadow_ray) for shadow rays. where: (x_loc, y_loc, z_loc) is the impact position in object coordinates. (x_pos, y_pos, z_pos) is the impact position in world coordinates. (x_nrm, y_nrm, z_nrm) is the impact normal vector in world coordinates. (x_dir, y_dir, z_dir) is the incoming ray direction vector in world coordinates. shadow_ray is a flag which is true (1) when incoming ray is a shadow ray. Remarks: To remove the callback, simply call this method with no parameter. If you use both impact aspect and volumetric density callbacks, you might obtain unexpected results; it is recommended to use one OR the other. Returns: True if the callback was succesfully set (or removed), false otherwise. See also: RayTrace, SetIntersectionCallback, SetVolumetricDensityCallback.

boolean SetInitFrameCallback (  function  fptrPythonInitFrameCallback = None  )

Sets a callback method that will be called each time the rendering of a new frame of the object begins. Parameters: fptrPythonInitFrameCallback  the python method that will be called each time the rendering of a new frame begins. Callback description: The Python callback should accept a single float as argument, and return nothing. The callback should look like this: double fptrPythonInitFrameCallback(float fFrameTime); where fFrameTime is the SMTP time of the frame. Remarks: To remove the callback, simply call this method with no parameter. Returns: True if the callback was succesfully set (or removed), false otherwise.

None SetLinkFlags (  boolean  bLinkPosition = true, boolean  bLinkRotation = true, boolean  bLinkSize = true, boolean  bLinkTwist = true )

Sets the type of linking between this object and the object it is linked to. Parameters: bLinkPosition  set to true if the object's position should be linked to that of it's parent object. bLinkRotation  set to true if the object's orientation should be linked to that of it's parent object. bLinkSize  set to true if the object's size should be linked to that of it's parent object. bLinkTwist  set to true if the object's twist should be linked to that of it's parent object. Remarks: Members of groups are necessarily linked to the group itself. You cannot override this setting. See also: SetLinkParent, SetTrackParent.

None SetLinkParent (  VUEBasicObject  pNewLinkParent = None  )

Sets the object that this object will be linked to. Parameters: pNewLinkParent  the object that this object will be linked to (or nothing if linking should be removed). Remarks: Members of groups are necessarily linked to the group itself. You cannot override this setting. See also: SetLinkFlags, SetTrackParent.

boolean SetMaterial (  str  cszMaterialName = "Default", int  nIndexInMatList = 0 )

Changes the material of the object. Parameters: cszMaterialName  name of new material to assign to the object. Remarks: Depending on the value of cszMaterialName, this function has two effects: If cszMaterialName is not indicated, or if cszMaterialName is "Default", assigns the default (beige) material to the object. If cszMaterialName is the name of a material in the scene, assigns that material to the object. Otherwise, attempts to load the material file cszMaterialName and assigns the material to the object. In this case, you can give a full path to a file or just the name of a material file in the Material folder. For instance: SetMaterial("Flat black") will load the file "Basic\01_Flat black.mat" in your Vue Material folder SetMaterial("c:\Materials\MyMaterial.mat") will load the file MyMaterial from the Material folder and assign it to the object. Parameters: nIndexInMatList  Index in the internal materials list of the object (between 0 and CountMaterials()-1) Returns: True if the material was successfully assigned to the object, false if the indicated file couldn't be loaded. See also: SetMaterialIndex, MaterialName, MaterialIndex, Material

boolean SetMaterialIndex (  int  nMaterialIndex, int  nIndexInMatList )

Changes the material of the object to the material of the indicated index. Parameters: nMaterialIndex  Index of new material to assign to the object. nIndexInMatList  Index in the internal materials list of the object (between 0 and CountMaterials()-1) Returns: True if the material was successfully assigned to the object, false if the material couldn't be assigned (e.g. the indicated material index doesn't exist). See also: SetMaterial, MaterialName, MaterialIndex, Material

None SetName (  str  cszNewName  )

Changes the name of the object. Parameters: cszNewName  new name of the object. Remarks: If the string is longer than 50 characters, it will be truncated.

None SetPivotPosition (  float  x = 0, float  y = 0, float  z = 0 )

Moves the object's pivot point along the world's X, Y and Z axes. Parameters: x  new pivot location relative to the center of the object on the X axis. y  new pivot location relative to the center of the object on the Y axis. z  new pivot location relative to the center of the object on the Z axis. If no parameters are specified, moves the pivot back to the center of the object.

None SetPosition (  float  x = 0, float  y = 0, float  z = 0 )

Moves the object to a given location in world coordinates. Parameters: x  new location on the X axis. y  new location on the Y axis. z  new location on the Z axis. Remarks: If no parameters are specified, moves the object to the origin of the world. See also: Move, MoveV, SetPositionV

None SetPositionV (  tuple_of_floats_x_y_z  vPosition  )

Moves the object to a given location in world coordinates, using a vector. Parameters: vPosition  new location (x, y, z). See also: Move, MoveV, SetPosition

None SetPreviewColor (  EPreviewColor  eNewColor  )

Sets the color used for previewing the object in the viewports.