Inheritance diagram for DzRenderOptions:
Enumerations | |
enum | PixelFilter { Box = 0, Triangle = 1, CatmullRom = 2, Gaussian = 3, Sinc = 4 } |
enum | RenderImgTarget { ActiveView = 0, NewWindow = 1, DirectToFile = 2 } |
enum | RenderMovTarget { MovieFile = 0, ImageSeries = 1 } |
enum | RenderStyle { Normal = 0, Cartoon = 1 } |
enum | RenderType { ScreenShot = 0, HardwareAssisted = 1, Software = 2 } |
Properties | |
Number | aspect |
Boolean | doubleSided |
Number | gain |
Number | gamma |
DzTime | getEndTime |
DzTime | getStartTime |
Size | imageSize |
Boolean | isAspectConstrained |
Boolean | isCurrentFrameRender |
String | lastRenderImgFilename |
String | lastRenderMovFilename |
String | lastRenderSerFilename |
Number | motionBlurOffset |
Number | motionBlurPct |
Number | numRenderers |
Number | openGLPasses |
PixelFilter | pixelFilter |
Number | rayTraceDepth |
String | renderImgFilename |
RenderImgTarget | renderImgToId |
String | renderMovFilename |
RenderMovTarget | renderMovToId |
String | renderSerFilename |
RenderStyle | renderStyle |
RenderType | renderType |
Boolean | renderViewport |
Number | shadingRate |
Number | shadowSamples |
Boolean | useGLSL |
Boolean | useMotionBlur |
Number | xFilterWidth |
Number | xPixelSamples |
Number | yFilterWidth |
Number | yPixelSamples |
Methods | |
void | applyChanges () |
void | resetOptions () |
void | setAspectRatio (Number widthRatio, Number heightRatio) |
Signals | |
void | aspectChanged (Number w, Number h) |
Signature: "aspectChanged(float,float)" | |
void | aspectChanged (Number val) |
Signature: "aspectChanged(double)" | |
void | aspectConstrainChanged (Boolean onOff) |
Signature: "aspectConstrainChanged(bool)" | |
void | doubleSidedChanged (Boolean onOff) |
Signature: "doubleSidedChanged(bool)" | |
void | endTimeChanged (DzTime time) |
Signature: "endTimeChanged(DzTime)" | |
void | gainChanged (Number gain) |
Signature: "gainChanged(double)" | |
void | gammaChanged (Number gamma) |
Signature: "gammaChanged(double)" | |
void | imageSizeChanged (Size size) |
Signature: "imageSizeChanged(const QSize&)" | |
void | motionBlurOffsetChanged (Number offset) |
Signature: "motionBlurOffsetChanged(double)" | |
void | motionBlurPctChanged (Number pct) |
Signature: "motionBlurPctChanged(int)" | |
void | openGLPassesChanged (Number passes) |
Signature: "openGLPassesChanged(int)" | |
void | pixelFilterChanged (DzRenderOptions::PixelFilter filter) |
Signature: "pixelFilterChanged(DzRenderOptions::PixelFilter)" | |
void | rayTraceDepthChanged (Number depth) |
Signature: "rayTraceDepthChanged(int)" | |
void | renderCurrentFrameChanged (Boolean onOff) |
Signature: "renderCurrentFrameChanged(bool)" | |
void | renderImgFilenameChanged (String filename) |
Signature: "renderImgFilenameChanged(const QString&)" | |
void | renderImgTargetChanged (DzRenderOptions::RenderImgTarget id) |
Signature: "renderImgTargetChanged(DzRenderOptions::RenderImgTarget)" | |
void | renderMovFilenameChanged (String filename) |
Signature: "renderMovFilenameChanged(const QString&)" | |
void | renderMovTargetChanged (DzRenderOptions::RenderMovTarget id) |
Signature: "renderMovTargetChanged(DzRenderOptions::RenderMovTarget)" | |
void | renderSerFilenameChanged (String filename) |
Signature: "renderSerFilenameChanged(const QString&)" | |
void | renderStyleChanged (DzRenderOptions::RenderStyle style) |
Signature: "renderStyleChanged(DzRenderOptions::RenderStyle)" | |
void | renderTypeChanged (DzRenderOptions::RenderType type) |
Signature: "renderTypeChanged(DzRenderOptions::RenderType)" | |
void | renderViewportChanged (Boolean onOff) |
Signature: "renderViewportChanged(bool)" | |
void | settingsChanged () |
Signature: "settingsChanged()" | |
void | shadingRateChanged (Number rate) |
Signature: "shadingRateChanged(double)" | |
void | shadowSamplesChanged (Number samples) |
Signature: "shadowSamplesChanged(int)" | |
void | startTimeChanged (DzTime time) |
Signature: "startTimeChanged(DzTime)" | |
void | useGLSLChanged (Boolean onOff) |
Signature: "useGLSLChanged(bool)" | |
void | useMotionBlurChanged (Boolean onOff) |
Signature: "useMotionBlurChanged(bool)" | |
void | xFilterWidthChanged (Number width) |
Signature: "xFilterWidthChanged(double)" | |
void | xPixelSamplesChanged (Number samples) |
Signature: "xPixelSamplesChanged(int)" | |
void | yFilterWidthChanged (Number width) |
Signature: "yFilterWidthChanged(double)" | |
void | yPixelSamplesChanged (Number samples) |
Signature: "yPixelSamplesChanged(int)" |
The RenderOptions class is responsible for the inclusion/exclusion of certain aspects of a render.
Types of Render Operations
void DzRenderOptions::applyChanges | ( | ) |
Writes render options via the settings manager.
Signature: "aspectChanged(float,float)"
Emitted when the aspect for the render has changed, or the viewport render status has changed.
void DzRenderOptions::aspectChanged | ( | Number | val | ) | [signal] |
Signature: "aspectChanged(double)"
Emitted when the aspect for the render has changed, or the viewport render status has changed.
void DzRenderOptions::aspectConstrainChanged | ( | Boolean | onOff | ) | [signal] |
Signature: "aspectConstrainChanged(bool)"
Emitted when the constrain aspect ratio setting has changed.
void DzRenderOptions::doubleSidedChanged | ( | Boolean | onOff | ) | [signal] |
Signature: "doubleSidedChanged(bool)"
Emitted when the double sided setting has changed.
void DzRenderOptions::endTimeChanged | ( | DzTime | time | ) | [signal] |
Signature: "endTimeChanged(DzTime)"
Emitted when the end time has changed.
void DzRenderOptions::gainChanged | ( | Number | rate | ) | [signal] |
Signature: "gainChanged(double)"
Emitted when the gain value has changed.
void DzRenderOptions::gammaChanged | ( | Number | rate | ) | [signal] |
Signature: "gammaChanged(double)"
Emitted when the gamma value has changed.
void DzRenderOptions::imageSizeChanged | ( | Size | size | ) | [signal] |
Signature: "imageSizeChanged(const QSize&)"
Emitted when the image size has changed.
void DzRenderOptions::motionBlurOffsetChanged | ( | Number | offset | ) | [signal] |
Signature: "motionBlurOffsetChanged(double)"
Emitted when the motion blur offset has changed.
void DzRenderOptions::motionBlurPctChanged | ( | Number | pct | ) | [signal] |
Signature: "motionBlurPctChanged(int)"
Emitted when the motion blur percentage has changed.
void DzRenderOptions::openGLPassesChanged | ( | Number | passes | ) | [signal] |
Signature: "openGLPassesChanged(int)"
Emitted when the number of OpenGL passes has changed.
void DzRenderOptions::pixelFilterChanged | ( | DzRenderOptions::PixelFilter | filter | ) | [signal] |
Signature: "pixelFilterChanged(DzRenderOptions::PixelFilter)"
Emitted when the pixel filter has changed.
void DzRenderOptions::rayTraceDepthChanged | ( | Number | depth | ) | [signal] |
Signature: "rayTraceDepthChanged(int)"
Emitted when the ray trace depth has changed.
void DzRenderOptions::renderCurrentFrameChanged | ( | Boolean | onOff | ) | [signal] |
Signature: "renderCurrentFrameChanged(bool)"
Emitted when the render current frame setting has changed.
void DzRenderOptions::renderImgFilenameChanged | ( | String | filename | ) | [signal] |
Signature: "renderImgFilenameChanged(const QString&)"
Emitted when the image filename for the render has changed.
void DzRenderOptions::renderImgTargetChanged | ( | DzRenderOptions::RenderImgTarget | id | ) | [signal] |
Signature: "renderImgTargetChanged(DzRenderOptions::RenderImgTarget)"
Emitted when the image target type for the render has changed.
void DzRenderOptions::renderMovFilenameChanged | ( | String | filename | ) | [signal] |
Signature: "renderMovFilenameChanged(const QString&)"
Emitted when the movie filename for the render has changed.
void DzRenderOptions::renderMovTargetChanged | ( | DzRenderOptions::RenderMovTarget | id | ) | [signal] |
Signature: "renderMovTargetChanged(DzRenderOptions::RenderMovTarget)"
Emitted when the movie target type for the render has changed.
void DzRenderOptions::renderSerFilenameChanged | ( | String | filename | ) | [signal] |
Signature: "renderSerFilenameChanged(const QString&)"
Emitted when the image series filename for the render has changed.
void DzRenderOptions::renderStyleChanged | ( | DzRenderOptions::RenderStyle | style | ) | [signal] |
Signature: "renderStyleChanged(DzRenderOptions::RenderStyle)"
Emitted when the render type has changed.
void DzRenderOptions::renderTypeChanged | ( | DzRenderOptions::RenderType | type | ) | [signal] |
Signature: "renderTypeChanged(DzRenderOptions::RenderType)"
Emitted when the render type has changed.
void DzRenderOptions::renderViewportChanged | ( | Boolean | onOff | ) | [signal] |
Signature: "renderViewportChanged(bool)"
Emitted when the render to viewport setting has changed.
void DzRenderOptions::resetOptions | ( | ) |
Sets values for render quality found in the stored settings.
Set current aspect width for this render. Represented as widthRatio : heightRatio.
void DzRenderOptions::settingsChanged | ( | ) | [signal] |
Signature: "settingsChanged()"
Emitted when any of the settings has changed.
void DzRenderOptions::shadingRateChanged | ( | Number | rate | ) | [signal] |
Signature: "shadingRateChanged(double)"
Emitted when the shading rate has changed.
void DzRenderOptions::shadowSamplesChanged | ( | Number | samples | ) | [signal] |
Signature: "shadowSamplesChanged(int)"
Emitted when the number of shadow samples has changed.
void DzRenderOptions::startTimeChanged | ( | DzTime | time | ) | [signal] |
Signature: "startTimeChanged(DzTime)"
Emitted when the start time has changed.
void DzRenderOptions::useGLSLChanged | ( | Boolean | onOff | ) | [signal] |
Signature: "useGLSLChanged(bool)"
Emitted when the use GLSL setting has changed.
void DzRenderOptions::useMotionBlurChanged | ( | Boolean | onOff | ) | [signal] |
Signature: "useMotionBlurChanged(bool)"
Emitted when the motion blur setting has changed.
void DzRenderOptions::xFilterWidthChanged | ( | Number | width | ) | [signal] |
Signature: "xFilterWidthChanged(double)"
Emitted when the X-axis filter width has changed.
void DzRenderOptions::xPixelSamplesChanged | ( | Number | samples | ) | [signal] |
Signature: "xPixelSamplesChanged(int)"
Emitted when the number of X-axis pixel samples has changed.
void DzRenderOptions::yFilterWidthChanged | ( | Number | width | ) | [signal] |
Signature: "yFilterWidthChanged(double)"
Emitted when the Y-axis filter width has changed.
void DzRenderOptions::yPixelSamplesChanged | ( | Number | samples | ) | [signal] |
Signature: "yPixelSamplesChanged(int)"
Emitted when the number of Y-axis pixel samples has changed.
The currently set aspect ratio (Read Only)
Whether or not to render polygons as double sided
The gain value
The gamma value
The scene time of the last frame to render
The scene time of the first frame to render
The size of the image to render
Whether or not to constrain the pixel dimensions of the render to the aspect ratio
Whether or not to render only the current frame
The filename of the last image rendered (Read Only)
The filename of the last movie rendered (Read Only)
The base filename of the image series rendered (Read Only)
The time offset for blurring
The amount of time between frames to blur across (0.0 - 1.0)
The number of available renderers (Read Only)
The number of passes for rendering in OpenGL
The pixel filter to use
The raytrace depth
The filename to save individual images to
The target for rendering individual images
The filename to save movies to
The target for rendering animations
The base filename to use when saving image series
The style of the render
The type of the render
Whether or not to use the aspect and size of the current viewport for the render
The shading rate
The number of samples when rendering shadows
Whether or not to use shaders when rendering in OpenGL
Whether or not to use motion blur
The width of the pixel filter in x
The number of samples per pixel in x
The width of the pixel filter in y
The number of samples per pixel in y