Main Page | Compound List | Compound Members

VUEInterface Class Reference


Public Types
enum	EMessageBoxButtons { MBB_Okay, MBB_Cancel, MBB_Yes, MBB_No, MBB_OkayCancel, MBB_YesNo, MBB_YesNoCancel }
enum	ETerrainType { TT_StandardTerrain, TT_ParametricTerrain, TT_BumpDisplacedTerrain }
enum	GBufferLayer { GBL_ZDepth, GBL_MaterialID, GBL_LayerID, GBL_UVCoords, GBL_Normals, GBL_RealPix, GBL_Coverage, GBL_RenderID, GBL_Color, GBL_Transparency, GBL_Velocity, GBL_SubPixWeight, GBL_SubPixMask, GBL_ALL }
enum	GBufferOption { GBO_ForceOccluded, GBO_GenerateAllAA }
enum	MultiPassSelectedLayer { MPO_PostProcess, MPO_AtmosphereGain, MPO_AtmosphereFilter, MPO_Radiosity, MPO_Background, MPO_Reflection, MPO_Refraction, MPO_Ambient, MPO_Shadow, MPO_Specular, MPO_Diffuse, MPO_GlobalAMask, MPO_ZDepth, MPO_XYNormal, MPO_ObjectID, MPO_MaterialID, MPO_XYZNormal, MPO_UVWCoords, MPO_DiffLight, MPO_SpecLight, MPO_Material, MPO_Rendering_All, MPO_Extra_All }
	Identifies the different layers available in multi-pass rendering. More...
enum	MultiPassSelectedMask { MPM_Layer, MPM_Object, MPM_Material, MPM_Ecosystem }
	Identifies the different types of masks available in multi-pass rendering. More...
Public Member Functions
VUEBasicObject	AddAlphaPlane (str strColorFilename=None, str strAlphaFilename=None)
	Adds a alpha plane to the scene.
VUEBasicObject	AddCloudPlane ()
	Adds a cloud plane to the scene.
VUEBasicObject	AddCone ()
	Adds a cone to the scene.
VUEBasicObject	AddCube ()
	Adds a cube to the scene.
VUEBasicObject	AddCylinder ()
	Adds a cylinder to the scene.
VUELight	AddDirectionalLight ()
	Adds a directional light (sun light) to the scene.
VUEBasicObject	AddGroundPlane ()
	Adds a ground plane to the scene.
VUEMeshObject	AddMesh ()
	Adds a mesh to the scene.
VUEBasicObject	AddPlane ()
	Adds a plane to the scene.
VUEBasicObject	AddPlanet ()
	Adds a planet to the scene.
VUEPlant	AddPlant (str strFilename=None)
	Adds a plant of the given species to the scene.
VUEPointLight	AddPointLight ()
	Adds a point light to the scene.
VUEBasicObject	AddPyramid ()
	Adds a pyramid to the scene.
VUEPythonObject	AddPythonObject (tuple_of_floats_x_y_z vMin, tuple_of_floats_x_y_z vMax, boolean bDisplayInViews)
	Adds a python object to the scene.
VUEPointLight	AddQuadraticPointLight ()
	Adds a quadratic point light to the scene.
VUESpotLight	AddQuadraticSpotLight ()
	Adds a quadratic spot light to the scene.
VUEBasicObject	AddSphere ()
	Adds a sphere to the scene.
VUESpotLight	AddSpotLight ()
	Adds a spot light to the scene.
VUEBasicObject	AddStone ()
	Adds a stone to the scene.
VUETerrain	AddSymmetricalTerrain (int nWidth=0, int nHeight=0)
	Adds a symmetrical terrain of given resolution to the scene. This function is deprecated. You should use AddTerrain() instead.
VUETerrain	AddTerrain (int nWidth=0, int nHeight=0, ETerrainType eType=TT_StandardTerrain, boolean bSymmetrical=false, boolean bSkinOnly=false)
	Adds a terrain of given resolution to the scene.
VUETorus	AddTorus ()
	Adds a torus to the scene.
VUEBasicObject	AddWaterPlane ()
	Adds a water plane to the scene.
None	CloseRenderDialog ()
	Close the Render Dialog.
boolean	Copy ()
	Copies the selected objects and places them on the clipboard.
int	CountMaterials ()
	Returns the number of materials used in the scene.
int	CountObjects ()
int	CountSelectedObjects ()
	Returns the number of objects currently selected.
VUEBasicObject	CSGDifference ()
	Creates a Boolean Difference of the selected objects.
VUEBasicObject	CSGIntersection ()
	Creates a Boolean Intersection of the selected objects.
VUEBasicObject	CSGUnion ()
	Creates a Boolean Union of the selected objects.
boolean	Cut ()
	Creates a copy of the selected objects and places it on the clipboard, then deletes the selected objects from the scene.
boolean	Delete ()
	Deletes the currently selected objects.
None	DeleteKeyFrame ()
	Deletes all keyframes at current time.
None	DeselectAll ()
	Deselects all selected objects in the scene.
None	DiscardRenderArea ()
	Discards the selected render area.
None	DisplayAlphaMask ()
	Displays the last render's color buffer.
None	DisplayAtmosphereEditor (boolean bShow=true)
	Shows/Hides the Atmosphere Editor.
None	DisplayColorPicture ()
	Displays the last render's color buffer.
None	DisplayControlToolbar (boolean bShow=true)
	Shows/Hides the Control Toolbar (the top toolbar).
None	DisplayDepthMap ()
	Displays the last render's color buffer.
None	DisplayInformationBar (boolean bShow=true)
	Shows/Hides the Information Bar (Object Properties, Scene Preview and World Browser panels).
None	DisplayMaterialSummary (boolean bShow=true)
	Shows/Hides the Material Summary.
None	DisplayObjectToolbar (boolean bShow=true)
	Shows/Hides the Object Toolbar (the left toolbar).
None	DisplayPythonConsole (boolean bShow=true)
	Shows/Hides the Python Console.
None	DisplayTimeline (boolean bShow=true)
	Shows/Hides the Timeline.
None	Drop ()
	Drops the selected objects to the closest object beneath them.
boolean	Duplicate ()
	Duplicates the selected objects and places them on the clipboard.
None	EnableGBLayer (GBufferLayer layer, boolean bEnable=true)
	Activate G-Buffer layers.
None	EnableGBOption (GBufferOption option, boolean bEnable=true)
	Activate G-Buffer options.
None	EnableGBuffer (boolean bEnable=true)
	Enable GBuffer Rendering.
None	EnableMPLayer (MultiPassSelectedLayer layer, boolean bEnable=true)
	Enable MultiPass Global Layers.
None	EnableMPMask (MultiPassSelectedMask mask, boolean bEnable=true)
	Enable MultiPass rendering for all layers, objects, materials or ecosystems, depending on the mask parameter.
None	EnableMPMaskOnEcosystem (VUEEcosystem pEco, boolean bEnable=true)
	Enable MultiPass rendering for a given ecosystem.
None	EnableMPMaskOnLayer (int nLayerIndex, boolean bEnable=true)
	Enable MultiPass rendering for a given layer.
None	EnableMPMaskOnMaterial (VUEMaterial pMat, boolean bEnable=true)
	Enable MultiPass rendering for a given material.
None	EnableMPMaskOnObject (VUEBasicObject pObj, boolean bEnable=true)
	Enable MultiPass rendering for a given object.
None	EnableMultiPass (boolean bEnable=true)
	Enable MultiPass Rendering.
boolean	ExportObject (str strFilename)
	Exports the selected objects to file.
float	GetAltitudeOnEcosystemAt (VUEEcosystem pEco, float x=0, float y=0)
	Get the altitude on an ecosystem point.
array_of_tuples_of_ints_r_g_b	GetColorLayer (int nLayer=0)
array_of_ints	GetCoverageLayer (int nLayer=0)
array_of_floats	GetDepthLayer (int nLayer=0)
VUEEcosystem	GetEcosystemOnObject (VUEBasicObject pObj)
	Get the ecosystem of an object.
VUEBasicObject	GetFirstHitObject (tuple_of_floats_x_y_z vStart, tuple_of_floats_x_y_z vDirection)
	Select the first object in given direction.
array_of_ints	GetLayerIDLayer (int nLayer=0)
array_of_ints	GetMaskLayer (int nLayer=0)
array_of_ints	GetMaterialLayer (int nLayer=0)
array_of_tuples_of_ints_r_g_b	GetMPColorLayer (MultiPassSelectedLayer layer)
	Get a MultiPass Color layer.
array_of_ints	GetMPEcosystemMask (VUEEcosystem pEco)
	Get MultiPass mask for a given ecosystem.
array_of_floats	GetMPFloatLayer (MultiPassSelectedLayer layer)
	Get a MultiPass float layer (MPO_ZDepth).
array_of_ints	GetMPIntLayer (MultiPassSelectedLayer layer)
	Get a MultiPass int layer (MPO_GlobalAMask,MPO_ObjectID,MPO_MaterialID).
array_of_ints	GetMPLayerMask (int nLayerIndex)
	Get MultiPass mask for a given layer.
array_of_ints	GetMPMask (int nMask)
	Get MultiPass mask.
array_of_ints	GetMPMaterialMask (VUEMaterial pMat)
	Get MultiPass mask for a given material.
array_of_ints	GetMPObjectMask (VUEBasicObject pObj)
	Get MultiPass mask for a given object.
array_of_tuples_of_floats_x_y_z	GetNormalLayer (int nLayer=0)
tuple_of_floats_x_y_z	GetNormalOnEcosystemAt (VUEEcosystem pEco, float x=0, float y=0)
	Get the normal on an ecosystem point.
array_of_ints	GetObjectIDLayer (int nLayer=0)
float	GetOpenGLFPS ()
	Return "frame rate" for the last computed frame in an Open GL view.
array_of_tuples_of_ints_r_g_b	GetRealColorLayer (int nLayer=0)
array_of_ints	GetRenderedAlphas ()
array_of_tuples_of_ints_r_g_b	GetRenderedColors ()
array_of_floats	GetRenderedDepths ()
None	GetSceneAtCurrentTime ()
	Update the Scene after a SetCurrentTime or SetCurrentFrame.
VUEBasicObject	GetSelectedObjectByIndex (int nIndex)
	Returns the n'th object from the selected objects list.
array_of_tuples_of_ints_r_g_b	GetTransparencyLayer (int nLayer=0)
array_of_tuples_of_floats_x_y	GetUVLayer (int nLayer=0)
array_of_tuples_of_floats_x_y	GetVelocityLayer (int nLayer=0)
array_of_tuples_of_ints_r_g_b	GetWeightLayer (int nLayer=0)
VUEBasicObject	Group ()
	Groups the selected objects.
None	HideAllButLayer (int nLayerIndex=-1)
	Hides all layers except the indicated layer.
boolean	HideLayer (int nLayerIndex)
	Hides a given layer.
VUEBasicObject	ImportObject (str strFilename)
	Imports the given object into the scene.
boolean	IsOpenGLSoftware ()
	Return the current OpenGL mode (hardware/software).
boolean	LoadAtmosphere (str strFilename)
	Loads the given atmosphere into the scene.
boolean	LockLayer (int nLayerIndex)
	Locks a given layer.
VUEMaterial	MaterialByIndex (int nIndex)
	Returns the material with the given index.
VUEMaterial	MaterialByName (str strMaterialName)
	Returns the first material with a given name.
None	MaximizeViewWindow ()
	Maximize main view window.
EMessageBoxButtons	Message (str szMessage, str szMessageBoxTitle="", EMessageBoxButtons eMessageBoxButtons=MBB_Okay)
	Displays a message box and waits for the user to press one of the buttons.
VUEBasicObject	MetaBlob ()
	Creates a MetaBlob of the selected objects.
None	NextKeyFrame ()
	Jump to next KeyFrame in Timeline as if Next button was clicked.
VUEBasicObject	ObjectByIndex (int nIndex)
	Returns the n'th primary object in the scene.
VUEBasicObject	ObjectByName (str strObjectName)
	Returns the first primary object with a given name.
VUEBasicObject	ObjectByNameHierarchy (str strObjectName)
	Returns the first object with a given name.
VUEBasicObject	ObjectByRenderID (int nRenderID)
	Returns the object in the scene that has given render ID.
list_of_objects	ObjectsByType (VUEBasicObject.EVueObjectType eObjectType)
	Returns a list of objects of the specified type.
int	Paste ()
	Pastes in the scene all the objects currently in the clipboard.
None	Play ()
	Play the Scene as if Play button was clicked.
None	PreviousKeyFrame ()
	Jump to previous KeyFrame in Timeline as if Previous button was clicked.
None	PrintPicture ()
	Prints the color buffer using default settings.
str	Prompt (str szPromptDescription, str szInitialValue="", boolean bUserMustProvideValue=true, str szPromptTitle="")
	Displays a small dialog box with an input field, prompting the user to enter a value.
int	RecomputeMatPreview (int iMatStart, int iMatEnd, int nThreads=4)
	Force Vue to compute the preview of a range of materials.
None	Refresh ()
	Refreshes the 3D Views.
None	Render (boolean bAllowMultiThreading=true)
	Renders the current scene.
boolean	ResumeRender ()
	Resumes rendering the current scene.
boolean	RunPythonFile (str strPythonScriptPath)
	Runs python script that corresponds to given file name and path.
None	SaveAlphaMask (str strFilename=None)
	Saves the last render's alpha mask to the indicated file.
None	SaveAtmosphere (str strFilename)
	Saves the current atmosphere to file.
None	SaveColorPicture (str strFilename=None)
	Saves the last render's color buffer to the indicated file.
None	SaveDepthMap (str strFilename=None)
	Saves the last render's depth buffer to the indicated file.
None	SaveScene (str strFilename=None)
	Saves the current scene to the indicated file.
int	Select (VUEBasicObject pObjectToBeSelected)
	Adds the indicated object to the current selection.
int	SelectAll ()
	Selects all objects in the scene.
int	SelectByLayer (int nLayerIndex)
	Adds to the current selection all primary objects from a given layer.
int	SelectByMaterial (int nMaterialIndex)
	Adds to the current selection all primary objects made from a given material.
int	SelectByName (str strObjectName)
	Adds to the current selection all primary objects that have the given name.
int	SelectByPreviewColor (EPreviewColor ePreviewColor)
	Adds to the current selection all primary objects of a given preview color.
int	SelectByType (VUEBasicObject.EVueObjectType eObjectType)
	Adds to the current selection all primary objects of a given type.
None	SelectOnly (VUEBasicObject pObjectToBeSelected)
	Selects the indicated object, and only that one.
None	SelectRenderArea (int nTop=0, int nLeft=0, int nBottom=0, int nRight=0)
	Selects the current render area.
boolean	SetMaterialByIndex (int nIndex, str strMaterialName="Default")
	Set the nIndex'th material in the global material list to the one specified by strMaterialName.
None	SetOpenGLSoftware (boolean bDontUseHardwareAcceleration, boolean bRelaunch)
	Set OpenGL mode (hardware/software). Relaunch Vue if different from current.
boolean	SetPictureFilterCallback (function fptrPythonPictureFilterCallback=None)
	Sets a callback method that will be called after the rendering of a picture.
None	SetRenderedAlphas (array_of_ints alphas)
	Overwrite the last rendered picture's alpha channel.
None	SetRenderedColors (array_of_tuples_of_ints_r_g_b colors)
	Overwrite the last rendered picture's color channel.
None	SetRenderedDepths (array_of_floats depths)
	Overwrite the last rendered picture's depth channel.
None	SetZoom (float fNewZoomFactor, EViewType eView=VT_All)
	Sets the zoom factor of the given orthogonal view(s). Doesn't affect the main view.
None	ShowAllLayers ()
	Shows all layers in the scene.
None	ShowLayer (int nLayerIndex)
	Shows a given layer.
None	Stop ()
	Stop the Scene as if Stop button was clicked.
int	StoreCamera ()
	Stores the current camera settings.
boolean	SwitchCamera (int nNewCamera)
	Activates a given camera setting.
int	Ungroup ()
	Ungroups the selected group or Boolean operation.
None	UseRenderArea (boolean bUseRenderArea=true)
	Enables/Disables the selected render area.
float	Zoom (EViewType eView)
	Returns the zoom factor of the orthogonal views.
None	ZoomScene ()
	Centers and zooms the orthogonal views so that they frame the entire scene. Doesn't affect the main view.
None	ZoomSelection ()
	Centers and zooms the orthogonal views so that they frame the selected objects. Doesn't affect the main view.

Member Enumeration Documentation

enum EMessageBoxButtons

Enumeration values:

MBB_Okay Identifies a single "OK" button.

MBB_Cancel Identifies a single "Cancel" button.

MBB_Yes Identifies a single "Yes" button.

MBB_No Identifies a single "No" button.

MBB_OkayCancel The message box will contain an "OK" and a "Cancel" button. The message box can return either MBB_Okay or MBB_Cancel.

MBB_YesNo The message box will contain a "Yes" and a "No" button. The message box can return either MBB_Yes or MBB_No.

MBB_YesNoCancel The message box will contain a "Yes", a "No" and a "Cancel" button. The message box can return either MBB_Yes, MBB_No or MBB_Cancel.

enum ETerrainType

Enumeration values:

TT_StandardTerrain Identifies the terrain type created when calling AddTerrain.

TT_ParametricTerrain

TT_BumpDisplacedTerrain

enum GBufferLayer

Enumeration values:

GBL_ZDepth

GBL_MaterialID

GBL_LayerID

GBL_UVCoords

GBL_Normals

GBL_RealPix

GBL_Coverage

GBL_RenderID

GBL_Color

GBL_Transparency

GBL_Velocity

GBL_SubPixWeight

GBL_SubPixMask

GBL_ALL

enum GBufferOption

Enumeration values:

GBO_ForceOccluded

GBO_GenerateAllAA

enum MultiPassSelectedLayer

Identifies the different layers available in multi-pass rendering.

See also:
EnableMultiPass, EnableMPLayer, GetMPColorLayer, GetMPFloatLayer, GetMPIntLayer

Remarks:
MPO_Rendering_All and MPO_Extra_All are used to select several layers at the same time.
The first group (MPO_Rendering_All) contains rendering layers: MPO_PostProcess, MPO_AtmosphereGain, MPO_AtmosphereFilter, MPO_Radiosity, MPO_Background, MPO_Reflection, MPO_Refraction, MPO_Ambient, MPO_Shadow, MPO_Specular, MPO_Diffuse,This group is selected by using MPO_Rendering_All.
The second group (MPO_Extra_all) contains extra layers: MPO_GlobalAMask, MPO_ZDepth, MPO_XYNormal, MPO_ObjectID, MPO_MaterialID.
MPO_Rendering_All and MPO_Extra_All are available only for selection (by using EnableMPLayer() function).

Enumeration values:

MPO_PostProcess

MPO_AtmosphereGain

MPO_AtmosphereFilter

MPO_Radiosity

MPO_Background

MPO_Reflection

MPO_Refraction

MPO_Ambient

MPO_Shadow

MPO_Specular

MPO_Diffuse

MPO_GlobalAMask

MPO_ZDepth

MPO_XYNormal

MPO_ObjectID

MPO_MaterialID

MPO_XYZNormal

MPO_UVWCoords

MPO_DiffLight

MPO_SpecLight

MPO_Material

MPO_Rendering_All

MPO_Extra_All

enum MultiPassSelectedMask

Identifies the different types of masks available in multi-pass rendering.

Remarks:
These masks are used for global selection. It means that MPM_Layer will be used to select all layers, and so on.

See also:
EnableMultiPass, EnableMPMask, EnableMPMaskOnObject, EnableMPMaskOnLayer, EnableMPMaskOnMaterial, EnableMPMaskOnEcosystem, GetMPObjectMask, GetMPMaterialMask, GetMPEcosystemMask

Enumeration values:

MPM_Layer

MPM_Object

MPM_Material

MPM_Ecosystem

Member Function Documentation

VUEBasicObject AddAlphaPlane ( str strColorFilename = None,

str strAlphaFilename = None

)

Adds a alpha plane to the scene.

Returns:
The newly created object.

VUEBasicObject AddCloudPlane ( )

Adds a cloud plane to the scene.

Returns:
The newly created object.

VUEBasicObject AddCone ( )

Adds a cone to the scene.

Returns:
The newly created object.

VUEBasicObject AddCube ( )

Adds a cube to the scene.

Returns:
The newly created object.

VUEBasicObject AddCylinder ( )

Adds a cylinder to the scene.

Returns:
The newly created object.

VUELight AddDirectionalLight ( )

Adds a directional light (sun light) to the scene.

Returns:
The newly created object.

VUEBasicObject AddGroundPlane ( )

Adds a ground plane to the scene.

Returns:
The newly created object.

VUEMeshObject AddMesh ( )

Adds a mesh to the scene.

Returns:
The newly created object.

VUEBasicObject AddPlane ( )

Adds a plane to the scene.

Returns:
The newly created object.

VUEBasicObject AddPlanet ( )

Adds a planet to the scene.

Returns:
The newly created object.

VUEPlant AddPlant ( str strFilename = None )

Adds a plant of the given species to the scene.

Returns:
The newly created object.

VUEPointLight AddPointLight ( )

Adds a point light to the scene.

Returns:
The newly created object.

VUEBasicObject AddPyramid ( )

Adds a pyramid to the scene.

Returns:
The newly created object.

VUEPythonObject AddPythonObject ( tuple_of_floats_x_y_z vMin,

tuple_of_floats_x_y_z vMax,

boolean bDisplayInViews

)

Adds a python object to the scene.

Parameters:

vMin the min corner of the python object's bounding box.

vMax the max corner of the python object's bounding box.

bDisplayInViews true if a preview box is to be displayed in views for modeling.

Returns:
The newly created object.

VUEPointLight AddQuadraticPointLight ( )

Adds a quadratic point light to the scene.

Returns:
The newly created object.

VUESpotLight AddQuadraticSpotLight ( )

Adds a quadratic spot light to the scene.

Returns:
The newly created object.

VUEBasicObject AddSphere ( )

Adds a sphere to the scene.

Returns:
The newly created object.

VUESpotLight AddSpotLight ( )

Adds a spot light to the scene.

Returns:
The newly created object.

VUEBasicObject AddStone ( )

Adds a stone to the scene.

Returns:
The newly created object.

VUETerrain AddSymmetricalTerrain ( int nWidth = 0,

int nHeight = 0

)

Adds a symmetrical terrain of given resolution to the scene. This function is deprecated. You should use AddTerrain() instead.

Returns:
The newly created object.

VUETerrain AddTerrain ( int nWidth = 0,

int nHeight = 0,

ETerrainType eType = TT_StandardTerrain,

boolean bSymmetrical = false,

boolean bSkinOnly = false

)

Adds a terrain of given resolution to the scene.

Returns:
The newly created object.

VUETorus AddTorus ( )

Adds a torus to the scene.

Returns:
The newly created object.

VUEBasicObject AddWaterPlane ( )

Adds a water plane to the scene.

Returns:
The newly created object.

None CloseRenderDialog ( )

Close the Render Dialog.

boolean Copy ( )

Copies the selected objects and places them on the clipboard.

Returns:
True if the objects were successfully copied.

See also:
Cut, Paste, Duplicate.

int CountMaterials ( )

Returns the number of materials used in the scene.

int CountObjects ( )

int CountSelectedObjects ( )

Returns the number of objects currently selected.
see GetSelectedObjectByIndex()

VUEBasicObject CSGDifference ( )

Creates a Boolean Difference of the selected objects.

Returns:
The newly created Boolean object if the operation was successful, or nothing if the operation failed (e.g. nothing or only one object selected).

Remarks:
Call Ungroup() to cancel the operation.

See also:
Ungroup, CSGUnion, CSGIntersection, Group, MetaBlob.

VUEBasicObject CSGIntersection ( )

Creates a Boolean Intersection of the selected objects.

Returns:
The newly created Boolean object if the operation was successful, or nothing if the operation failed (e.g. nothing or only one object selected).

Remarks:
Call Ungroup() to cancel the operation.

See also:
Ungroup, CSGUnion, Group, CSGDifference, MetaBlob.

VUEBasicObject CSGUnion ( )

Creates a Boolean Union of the selected objects.

Returns:
The newly created Boolean object if the operation was successful, or nothing if the operation failed (e.g. nothing or only one object selected).

Remarks:
Call Ungroup() to cancel the operation.

See also:
Ungroup, Group, CSGIntersection, CSGDifference, MetaBlob.

boolean Cut ( )

Creates a copy of the selected objects and places it on the clipboard, then deletes the selected objects from the scene.

Remarks:
Equivalent to calling Copy() and then Delete().

Returns:
True if the objects were successfully cut.

See also:
Copy, Paste, Duplicate, Delete.

boolean Delete ( )

Deletes the currently selected objects.

Returns:
True if the objects were successfully deleted.

See also:
Cut.

None DeleteKeyFrame ( )

Deletes all keyframes at current time.
If some objects are selected, only deletes the keyframes of the selected objects.
See also:
CurrentTime, SetCurrentTime.

None DeselectAll ( )

Deselects all selected objects in the scene.

Returns:
The total number of objects that are selected after the operation.

See also:
SelectAll, Select, SelectOnly, SelectByPreviewColor, SelectByType, SelectByMaterial, SelectByName, SelectByLayer.

None DiscardRenderArea ( )

Discards the selected render area.

See also:
SelectRenderArea, DiscardRenderArea.

None DisplayAlphaMask ( )

Displays the last render's color buffer.
If no color buffer is available, this function does nothing.
See also:
DisplayColorBuffer, DisplayDistanceBuffer.

None DisplayAtmosphereEditor ( boolean bShow = true )

Shows/Hides the Atmosphere Editor.

Parameters:

bShow if true, causes the dialog to be displayed, if false, causes it to be closed.

None DisplayColorPicture ( )

Displays the last render's color buffer.
If no color buffer is available, this function does nothing.
See also:
DisplayAlphaBuffer, DisplayDistanceBuffer.

None DisplayControlToolbar ( boolean bShow = true )

Shows/Hides the Control Toolbar (the top toolbar).

Parameters:

bShow if true, causes the dialog to be displayed, if false, causes it to be closed.

None DisplayDepthMap ( )

Displays the last render's color buffer.
If no color buffer is available, this function does nothing.
See also:
DisplayColorBuffer, DisplayAlphaBuffer.

None DisplayInformationBar ( boolean bShow = true )

Shows/Hides the Information Bar (Object Properties, Scene Preview and World Browser panels).

Parameters:

bShow if true, causes the dialog to be displayed, if false, causes it to be closed.

None DisplayMaterialSummary ( boolean bShow = true )

Shows/Hides the Material Summary.

Parameters:

bShow if true, causes the dialog to be displayed, if false, causes it to be closed.

None DisplayObjectToolbar ( boolean bShow = true )

Shows/Hides the Object Toolbar (the left toolbar).

Parameters:

bShow if true, causes the dialog to be displayed, if false, causes it to be closed.

None DisplayPythonConsole ( boolean bShow = true )

Shows/Hides the Python Console.

Parameters:

bShow if true, causes the dialog to be displayed, if false, causes it to be closed.

None DisplayTimeline ( boolean bShow = true )

Shows/Hides the Timeline.

Parameters:

bShow if true, causes the dialog to be displayed, if false, causes it to be closed.

None Drop ( )

Drops the selected objects to the closest object beneath them.

boolean Duplicate ( )

Duplicates the selected objects and places them on the clipboard.

Returns:
True if the objects were successfully duplicated.

Remarks:
Equivalent to Copy() followed by Paste().

See also:
Cut, Copy, Paste.

None EnableGBLayer ( GBufferLayer layer,

boolean bEnable = true

)

Activate G-Buffer layers.

Parameters:

layer This GBufferLayer will select the G-Buffer layer to activate.

bEnable a boolean. True will enable the creation of GBuffer during rendering, False will disable it.

See also:
EnableGBuffer, EnableGBOption, GBufferLayer

None EnableGBOption ( GBufferOption option,

boolean bEnable = true

)

Activate G-Buffer options.

Parameters:

option This GBufferOption will select the G-Buffer option to activate.

bEnable a boolean. True will enable the creation of GBuffer during rendering, False will disable it.

See also:
EnableGBuffer, EnableGBLayer, GBufferOption

None EnableGBuffer ( boolean bEnable = true )

Enable GBuffer Rendering.

Parameters:

bEnable a boolean. True will enable the creation of GBuffer during rendering, False will disable it.

See also:
EnableGBOption, EnableGBLayer

None EnableMPLayer ( MultiPassSelectedLayer layer,

boolean bEnable = true

VUEInterface Class Reference

Public Types

Public Member Functions

Member Enumeration Documentation

Member Function Documentation