DzRenderOptions Class Reference
[Rendering Objects]

This class manages the inclusion/exclusion of render options. More...

Inheritance diagram for DzRenderOptions:

QObject Object List of all members.

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)"

Detailed Description

This class manages the inclusion/exclusion of render options.

The RenderOptions class is responsible for the inclusion/exclusion of certain aspects of a render.


Member Enumeration Documentation

enum DzRenderOptions::PixelFilter

The types of pixel filters available for RenderMan renders.

Enumerator:
Box  The Box filter.
Triangle  The triangle filter.
CatmullRom  The Catmull-Rom filter.
Gaussian  The Gaussian filter.
Sinc  The Sinc filter.

enum DzRenderOptions::RenderImgTarget

Types of Render Destinations

Enumerator:
ActiveView  Renders the image in the active viewport.
NewWindow  Renders the image in a new window.
DirectToFile  Renders the image directly to a file.

enum DzRenderOptions::RenderMovTarget

The Types of Movies that can be rendered

Enumerator:
MovieFile  A video file created/compressed by system specific video API's.
ImageSeries  A series of image files, one for each frame in the movie.

enum DzRenderOptions::RenderStyle

The style of the render

Enumerator:
Normal  The shaders/materials for the objects will be used to render.
Cartoon  The entire scene will be rendered with a cartoon style shader.

enum DzRenderOptions::RenderType

Types of Render Operations

Enumerator:
ScreenShot  Performs a 'Screen Shot' render, grabbing a frame from the interactive OpenGL viewport.
HardwareAssisted  Performs a 'Fast Time' render, using OpenGL to create a render quality image.
Software  Perfomrs an 'Offline' render with the current RenderMan renderer.


Member Function Documentation

void DzRenderOptions::applyChanges (  ) 

Writes render options via the settings manager.

void DzRenderOptions::aspectChanged ( Number  w,
Number  h 
) [signal]

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.

void DzRenderOptions::setAspectRatio ( Number  widthRatio,
Number  heightRatio 
)

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.


Member Data Documentation

Number DzRenderOptions::aspect

The currently set aspect ratio (Read Only)

Boolean DzRenderOptions::doubleSided

Whether or not to render polygons as double sided

Number DzRenderOptions::gain

The gain value

Number DzRenderOptions::gamma

The gamma value

DzTime DzRenderOptions::getEndTime

The scene time of the last frame to render

DzTime DzRenderOptions::getStartTime

The scene time of the first frame to render

Size DzRenderOptions::imageSize

The size of the image to render

bool DzRenderOptions::isAspectConstrained

Whether or not to constrain the pixel dimensions of the render to the aspect ratio

bool DzRenderOptions::isCurrentFrameRender

Whether or not to render only the current frame

String DzRenderOptions::lastRenderImgFilename

The filename of the last image rendered (Read Only)

String DzRenderOptions::lastRenderMovFilename

The filename of the last movie rendered (Read Only)

String DzRenderOptions::lastRenderSerFilename

The base filename of the image series rendered (Read Only)

Number DzRenderOptions::motionBlurOffset

The time offset for blurring

Number DzRenderOptions::motionBlurPct

The amount of time between frames to blur across (0.0 - 1.0)

Number DzRenderOptions::numRenderers

The number of available renderers (Read Only)

int DzRenderOptions::openGLPasses

The number of passes for rendering in OpenGL

PixelFilter DzRenderOptions::pixelFilter

The pixel filter to use

int DzRenderOptions::rayTraceDepth

The raytrace depth

String DzRenderOptions::renderImgFilename

The filename to save individual images to

RenderImgTarget DzRenderOptions::renderImgToId

The target for rendering individual images

String DzRenderOptions::renderMovFilename

The filename to save movies to

RenderMovTarget DzRenderOptions::renderMovToId

The target for rendering animations

String DzRenderOptions::renderSerFilename

The base filename to use when saving image series

RenderStyle DzRenderOptions::renderStyle

The style of the render

DzRenderOptions::RenderType DzRenderOptions::renderType

The type of the render

bool DzRenderOptions::renderViewport

Whether or not to use the aspect and size of the current viewport for the render

Number DzRenderOptions::shadingRate

The shading rate

Number DzRenderOptions::shadowSamples

The number of samples when rendering shadows

bool DzRenderOptions::useGLSL

Whether or not to use shaders when rendering in OpenGL

bool DzRenderOptions::useMotionBlur

Whether or not to use motion blur

Number DzRenderOptions::xFilterWidth

The width of the pixel filter in x

Number DzRenderOptions::xPixelSamples

The number of samples per pixel in x

Number DzRenderOptions::yFilterWidth

The width of the pixel filter in y

Number DzRenderOptions::yPixelSamples

The number of samples per pixel in y


Generated on Thu Sep 24 12:21:14 2009

Copyright © 2002 - 2009 DAZ 3D, Inc.