Main Page | Compound List | Compound Members

VUEScene Class Reference


Your Ad Here


List of all members.

Public Member Functions

float AspectRatio ()
 Returns the aspect ratio of the picture.
float CurrentFrame ()
 Returns the current frame.
float CurrentTime ()
 Returns the current time.
float FrameRate ()
 Returns the frame rate (in frames per second).
int PictureHeight ()
 Returns the height of the picture.
int PictureWidth ()
 Returns the width of the picture.
str PythonStartupScriptPath ()
 Returns the path to the script that will be automatically run after the scene is loaded (if any).
ERenderOutput RenderOutput ()
 Returns the current render output destination.
EPresetRenderSettings RenderQuality ()
 Returns the current pictures render quality setting.
None SetAspectRatio (float fNewAspectRatio)
 Sets the aspect ratio of the picture.
None SetCurrentFrame (float fNewFrame)
 Sets the current frame.
None SetCurrentTime (float fNewTime)
 Sets the current time.
None SetFrameRate (float fNewFrameRate)
 Sets the frame rate (in frames per second).
None SetPictureHeight (int nNewPictureHeight)
 Sets the height of the picture.
None SetPictureSize (int nNewPictureWidth, int nNewPictureHeight)
 Sets the size of the picture, and adjusts aspect ratio accordingly.
None SetPictureWidth (int nNewPictureWidth)
 Sets the width of the picture.
boolean SetPixelFilterCallback (function fptrPythonPixelFilterCallback=None)
 Sets a callback method that will be called after the rendering of each pixel.
boolean SetPythonStartupScriptPath (str strPythonStartupScriptPath=None)
 Sets the path to the script that will be automatically run after the scene is loaded.
None SetRenderOutput (ERenderOutput eRenderOutput=RO_Screen)
 Sets the render output destination.
None SetRenderQuality (EPresetRenderSettings eRenderSetting=PRS_Final)
 Sets the picture's render quality setting.
boolean SetSkyFilterCallback (function fptrPythonSkyFilterCallback=None)
 Sets a callback method that will be called each time sky computation must be performed.

Member Function Documentation

float AspectRatio (   ) 
 

Returns the aspect ratio of the picture.

float CurrentFrame (   ) 
 

Returns the current frame.

See also:
SetCurrentTime, CurrentTime, SetCurrentFrame.

float CurrentTime (   ) 
 

Returns the current time.

See also:
SetCurrentTime, FrameRate, SetFrameRate.

float FrameRate (   ) 
 

Returns the frame rate (in frames per second).

See also:
SetCurrentTime, CurrentTime, SetFrameRate.

int PictureHeight (   ) 
 

Returns the height of the picture.

int PictureWidth (   ) 
 

Returns the width of the picture.

str PythonStartupScriptPath (   ) 
 

Returns the path to the script that will be automatically run after the scene is loaded (if any).

See also:
SetPythonStartupScriptPath to set the startup script path.

ERenderOutput RenderOutput (   ) 
 

Returns the current render output destination.

See also:
ERenderOutput, SetRenderOutput.

EPresetRenderSettings RenderQuality (   ) 
 

Returns the current pictures render quality setting.

See also:
EPresetRenderSettings, SetRenderQuality.

None SetAspectRatio (  float  fNewAspectRatio  ) 
 

Sets the aspect ratio of the picture.

Parameters:
fNewaspectRatio the new aspect ratio of the picture.
Remarks:
Change the height of the picture
See also:
aspectRatio, SetPictureSize.

None SetCurrentFrame (  float  fNewFrame  ) 
 

Sets the current frame.

Parameters:
fNewFrame the new current time.
Remarks:
Setting the current frale will modify all animated objects accordingly.
See also:
CurrentTime, SetCurrentTime, CurrentFrame, FrameRate, SetFrameRate.

None SetCurrentTime (  float  fNewTime  ) 
 

Sets the current time.

Parameters:
fNewTime the new current time.
Remarks:
Setting the current time will modify all animated objects accordingly.
See also:
CurrentTime, CurrentFrameRate, SetCurrentFrameRate.

None SetFrameRate (  float  fNewFrameRate  ) 
 

Sets the frame rate (in frames per second).

Parameters:
fNewFrameRate the new frame rate.
See also:
FrameRate, CurrentTime, SetCurrentTime

None SetPictureHeight (  int  nNewPictureHeight  ) 
 

Sets the height of the picture.

Parameters:
nNewPictureHeight the new height of the picture.
Remarks:
If the current render output is set to render in the main view, the render output will be switched to screen.

The width of the picture will be adjusted according to the current aspect ratio,

See also:
SetPictureWidth, SetPictureSize, PictureHeight, aspectRatio.

None SetPictureSize (  int  nNewPictureWidth,
int  nNewPictureHeight
) 
 

Sets the size of the picture, and adjusts aspect ratio accordingly.

Parameters:
nNewPictureWidth the new width of the picture.
nNewPictureHeight the new height of the picture.
Remarks:
If the current render output is set to render in the main view, the render output will be switched to screen.

The aspect ratio of the picture will be adjusted according to the aspect ratio of the indicated width and height,

See also:
SetPictureWidth, PictureHeight, aspectRatio.

None SetPictureWidth (  int  nNewPictureWidth  ) 
 

Sets the width of the picture.

Parameters:
nNewPictureWidth the new width of the picture.
Remarks:
If the current render output is set to render in the main view, the render output will be switched to screen.

The height of the picture will be adjusted according to the current aspect ratio,

See also:
SetPictureHeight, PictureWidth, aspectRatio.

boolean SetPixelFilterCallback (  function  fptrPythonPixelFilterCallback = None  ) 
 

Sets a callback method that will be called after the rendering of each pixel.

Parameters:
fptrPythonPixelFilterCallback the python method that will be called each time a pixel is rendered.
Remarks:
This callback can be used to modify the color of the pixels on the fly as they are rendered (e.g. to convert the colors to black and white). The callback has access to the pixel's opacity and distance. The callback will be called each time a pixel is rendered, including any anti-aliasing passes (with the exception of texture supersampling and effects such as blurry reflections).
Callback description:
The Python callback should accept 4 floats and a color, and return a color. The callback should look like this:
COLOR fptrPythonPixelFilterCallback(float x_pixel, float y_pixel, COLOR clrPixel, float fAlpha, float fDistanceToObject);
where:
x_pixel is the x coordinate of the pixel that has just been rendered (not necessarily a round value).
y_pixel is the y coordinate of the pixel that has just been rendered (not necessarily a round value).
clrPixel is the color of the pixel that has just been rendered.
fAlpha is the transparency of the pixel that has just been rendered. Values range from 0 through 1, 1 being fully opaque.
fDistanceToObject is the distance to the object that was hit at that pixel.
Remarks:
To remove the callback, simply call this method with no parameter. The size of the picture can be retrieved by calling PictureWidth() and PictureHeight().
Returns:
True if the callback was succesfully set (or removed), false otherwise.
See also:
PictureWidth, PictureHeight, SetRenderedPicture, SetSkyFilterCallback.

boolean SetPythonStartupScriptPath (  str  strPythonStartupScriptPath = None  ) 
 

Sets the path to the script that will be automatically run after the scene is loaded.

Parameters:
strPythonStartupScriptPath the path to the startup script.
Remarks:
To remove the startup script, simply call this function with no parameter.
Returns:
True if the startup script was set/removed succesfully, false if the script wasn't found.
See also:
PythonStartupScriptPath.

None SetRenderOutput (  ERenderOutput  eRenderOutput = RO_Screen  ) 
 

Sets the render output destination.

Parameters:
eRenderOutput the new render output destination. This value can be VuePython.RO_MainView, VuePython.RO_Screen or VuePython.RO_Disk
Remarks:
This function must be called before rendering begins.
See also:
ERenderOutput, RenderOutput.

None SetRenderQuality (  EPresetRenderSettings  eRenderSetting = PRS_Final  ) 
 

Sets the picture's render quality setting.

Parameters:
eRenderSetting the new render quality setting. This value can be VuePython.PRS_Sketch, VuePython.PRS_Preview, VuePython.PRS_Final, VuePython.PRS_Broadcast, VuePython.PRS_Superior, VuePython.PRS_Ultra, VuePython.PRS_User, VuePython.PRS_ObjectPreview or VuePython.PRS_ScenePreview
Remarks:
This function must be called before rendering begins.
See also:
EPresetRenderSettings, RenderQuality.

boolean SetSkyFilterCallback (  function  fptrPythonSkyFilterCallback = None  ) 
 

Sets a callback method that will be called each time sky computation must be performed.

Parameters:
fptrPythonSkyFilterCallback the python method that will be called each time sky computation must be performed.
Remarks:
This callback can be used to Add custom effects to the sky rendering. By returning a non zero transparency amount, your effects will be blended with standard Vue sky. The callback will be called just before Vue computes the sky color, with wich your return color will be blended according to the transparency amount you return. You also have the possibility to specify whether the effect should be applied behind clouds, or to both sky and clouds.
Callback description:
The Python callback should accept 6 floats, and return 4 ints (your sky color and behind clouds flag) and a float (transparency amount). The callback should look like this:
(i, i, i, i, f) fptrPythonSkyFilterCallback(x_pos, y_pos, z_pos, x_dir, y_dir, z_dir)
where:
(x_pos, y_pos, z_pos) is the ray starting point.
(x_dir, y_dir, z_dir) is the ray direction vector.
Remarks:
To remove the callback, simply call this method with no parameter.
Returns:
True if the callback was succesfully set (or removed), false otherwise.
See also:
SetPixelFilterCallback

Generated using doxygen on Wed Nov 29 17:50:20 2006.
©2003 e-on software, inc. All rights reserved.

Return to Vue Index


Your Ad Here