VUEApplication Class Reference

Your Ad Here

List of all members.

Public Member Functions
None	AddRenderCow (str cszAddress, int nPort)
	Adds a RenderCow to the RenderCow list.
boolean	CloseFile ()
	Closes the current scene.
None	EnableMessageBoxes (boolean bEnable=true)
	Enables or disables the displaying of Messages Boxes.
None	EnableRenderCow (str cszIP, boolean bEnable)
	Enables or disables a RenderCow.
None	ForceTileSize (int width, int height)
	Specifies the dimensions of the tiles to be used for the network rendering. UseDefaultTileSize.
list_of_tuples_with_name_ip_selection_state_statedescripion	GetRenderCowStatus ()
	Returns the status of all the RenderCows in HyperVue.
boolean	LoadFile (str cszFileName)
	Loads the specified scene.
boolean	SaveFile (str cszFileName=None)
	Saves the current scene.
boolean	SetFeedBackProgressionCallback (function fptrPythonFeedBackProgressionCallback=None)
	Sets a call back method that will be called during the rendering process to provide feedback on the progress of the render.
boolean	SetHyperVueFeedBackProgressionCallback (function fptrPythonHyperVueFeedBackProgressionCallback=None)
	Sets a call back method that will be called regularly during network rendering (each time a RenderCow provides an update of its render status).
boolean	TestLoaded ()
	Test if a scene is loaded.
None	UseDefaultTileSize ()
	Requests that the default tile size be used for the network rendering. ForceTileSize.

---

Member Function Documentation

None AddRenderCow (  str  cszAddress, int  nPort )

Adds a RenderCow to the RenderCow list. Parameters: cszAddress  is the address of the RenderCow to be added nPort  is the port numberof the rendercow to be added.

boolean CloseFile (   )

Closes the current scene. Returns: True if the scene could be closed. See also: LoadFile, SaveFile.

None EnableMessageBoxes (  boolean  bEnable = true  )

Enables or disables the displaying of Messages Boxes. Parameters: bEnable  is a bool indicating whether message boxes should be displayed or not. Remarks: Calling this function with bEnable set to false will disable *all* Message Boxes throughout the entire application. This is the same as if the Message Box had been displayed and the user had clicked the OK or YES buttons each time.

None EnableRenderCow (  str  cszIP, boolean  bEnable )

Enables or disables a RenderCow. Parameters: cszIP  is a string containing the IP address of the render cow bEnable  true if the RenderCow should be used for rendering, false otherwise.

None ForceTileSize (  int  width, int  height )

Specifies the dimensions of the tiles to be used for the network rendering. UseDefaultTileSize.

list_of_tuples_with_name_ip_selection_state_statedescripion GetRenderCowStatus (   )

Returns the status of all the RenderCows in HyperVue. Remarks: Each item in the list is a tuple of the following form: (name, ip_address, bIsSelected, bIsFree, current_state) where: name is a string containing the hostname of the RenderCow, ip_address is a string containing the network ip address of the RenderCow, bIsSelected is 1 if the RenderCow is selected for rendering and 0 otherwise, bIsFree is 1 if the RenderCow is free for render and 0 if it is busy, current_state is a string describing the current state of the RenderCow. This function can only be called during the network rendering process.

boolean LoadFile (  str  cszFileName  )

Loads the specified scene. Parameters: cszFileName  the filename of the scene to be loaded. Returns: True if the scene was correctly loaded. See also: SaveFile, CloseFile.

boolean SaveFile (  str  cszFileName = None  )

Saves the current scene. Parameters: cszFileName  the filename under which the scene should be saved. If None, the current filename is used. Returns: True if the scene was correctly saved. See also: LoadFile, CloseFile.

boolean SetFeedBackProgressionCallback (  function  fptrPythonFeedBackProgressionCallback = None  )

Sets a call back method that will be called during the rendering process to provide feedback on the progress of the render. Parameters: fptrPythonFeedBackProgressionCallback  the python callback method that will be called during render. Callback description: The callback must look like this: fptrPythonFeedBackProgressionCallback(fProgression, fTimeLeft, nRenderState); Where: fProgression is a float value indicating the percentage of progression of the current render stage fTimeLeft is an estimation of the remaining render time in seconds nRenderState is the current render stage. Possible values are: VuePython.RSRendering, VuePython.RSAntiAliasing, VuePython.RS2DMotionBlur, VuePython.RSGlow and VuePython.RSAntiAliasingGlow Remarks: To remove the callback, simply call this method with no parameter. See also: SetHyperVueFeedBackProgressionCallback

boolean SetHyperVueFeedBackProgressionCallback (  function  fptrPythonHyperVueFeedBackProgressionCallback = None  )

Sets a call back method that will be called regularly during network rendering (each time a RenderCow provides an update of its render status). Parameters: fptrPythonHyperVueFeedBackProgressionCallback  the python callback method that will be called during network rendering. Callback description: The callback takes no arguments. See GetRenderCowStatus() to get information on the status of the RenderCows See also: GetRenderCowStatus

boolean TestLoaded (   )

Test if a scene is loaded. Returns: True if a scene is loaded See also: LoadFile.

None UseDefaultTileSize (   )

Requests that the default tile size be used for the network rendering. ForceTileSize.

---

Return to Vue Index

Your Ad Here