DzPBufferView Class Reference

Convenience class for rendering arbitrary views of the scene with the application-wide PBuffer. More...

Inheritance diagram for DzPBufferView:

QObject Object List of all members.

Methods

void aimCamera ()
void frameCamera ()
Boolean getAxesOn ()
Color getBackground ()
DzCamera getCamera ()
DzDrawStyle getDrawStyle ()
Boolean getFloorOn ()
Image getImage ()
Boolean hardwareRender (DzRenderHandler handler)
Boolean isValid ()
Number pickOnGizmo (Point pnt)
DzMaterial pickOnMaterial (Point pnt)
DzNode pickOnNode (Point pnt)
Boolean redraw (Boolean drawGizmos)
Boolean renderThumbnail (DzRenderHandler handler)
void resetCamera ()
void resize (Size size)
void setAxesOn (Boolean onOff)
void setBackground (Color color)
void setCamera (DzCamera cam)
void setDrawStyle (DzDrawStyle style)
void setFloorOn (Boolean onOff)
Size size ()

Constructors

 DzPBufferView (Size size)
 DzPBufferView ()

Signals

void activeCameraChanged (DzCamera cam)
 Signature: "activeCameraChanged(DzCamera*)"
void axesOnChanged (Boolean onOff)
 Signature: "axesOnChanged(bool)"
void backgroundColorChanged (Color color)
 Signature: "backgroundColorChanged(const QColor&)"
void drawStyleChanged (DzDrawStyle style)
 Signature: "drawStyleChanged(DzDrawStyle*)"
void floorOnChanged (Boolean onOff)
 Signature: "floorOnChanged(bool)"
void sizeChanged (Size size)
 Signature: "sizeChanged(const QSize&)"
void viewChanged ()
 Signature: "viewChanged()"

Detailed Description

Convenience class for rendering arbitrary views of the scene with the application-wide PBuffer.


Constructor & Destructor Documentation

DzPBufferView::DzPBufferView (  ) 

Default Constructor

DzPBufferView::DzPBufferView ( Size  size  ) 

Creates a view with the given size.

Parameters:
size The sive of the view - i.e. the size of the rendered image


Member Function Documentation

void DzPBufferView::activeCameraChanged ( DzCamera  cam  )  [signal]

Signature: "activeCameraChanged(DzCamera*)"

Emitted when the camera for the view has been changed.

void DzPBufferView::aimCamera (  ) 

Aims the view's camera at the currently selected item(s) in the scene.

void DzPBufferView::axesOnChanged ( Boolean  onOff  )  [signal]

Signature: "axesOnChanged(bool)"

Emitted when drawing of the axes in the view is enabled or disabled.

void DzPBufferView::backgroundColorChanged ( Color  color  )  [signal]

Signature: "backgroundColorChanged(const QColor&)"

Emitted when the background color for the view has been changed.

void DzPBufferView::drawStyleChanged ( DzDrawStyle  style  )  [signal]

Signature: "drawStyleChanged(DzDrawStyle*)"

Emitted when the drawstyle for the view has been changed.

void DzPBufferView::floorOnChanged ( Boolean  onOff  )  [signal]

Signature: "floorOnChanged(bool)"

Emitted when drawing of the floor in the view is enabled or disabled.

void DzPBufferView::frameCamera (  ) 

Frames the currently selected scene item(s) in the view's camera.

Boolean DzPBufferView::getAxesOn (  ) 

Returns:
true if the world-space axes are currently visible in renders through this view, otherwise false.

Color DzPBufferView::getBackground (  ) 

Returns:
The current background color for the view.

DzCamera DzPBufferView::getCamera (  ) 

Returns:
The camera currently used by this view.

DzDrawStyle DzPBufferView::getDrawStyle (  ) 

Returns:
The current drawstyle used by the view.

Boolean DzPBufferView::getFloorOn (  ) 

Returns:
true if the floor is currently visible in renders through this view, otherwise false.

QImage DzPBufferView::getImage (  ) 

Returns:
The result of the last rendering operation through this view.

Boolean DzPBufferView::hardwareRender ( DzRenderHandler  handler  ) 

Performs a hardware-rendering operation through this view.

Parameters:
handler The render-handler for the operation.
Returns:
true on success, false on failure.

Boolean DzPBufferView::isValid (  ) 

Returns:
true if the global PBuffer is valid and available for use by this view.

Number DzPBufferView::pickOnGizmo ( Point  pnt  ) 

Performs a view tool gizmo-picking operation through the view.

Parameters:
pnt The point in the view to perform the picking operation.
Returns:
The index of the gizmo that is at the given point in the view, or NULL if none.

DzMaterial DzPBufferView::pickOnMaterial ( Point  pnt  ) 

Performs a material-picking operation through the view.

Parameters:
pnt The point in the view to perform the picking operation.
Returns:
A pointer to the material that is at the given point in the view, or NULL if none.

DzNode DzPBufferView::pickOnNode ( Point  pnt  ) 

Performs a node-picking operation through the view.

Parameters:
pnt The point in the view to perform the picking operation.
Returns:
A pointer to the scene node that is at the given point in the view, or NULL if none.

Boolean DzPBufferView::redraw ( Boolean  drawGizmos  ) 

Renders the current scene through the view

Parameters:
drawGizmos Whether or not the current viewtool is drawn. If true, the current view tool will be drawn in the render, otherwise, the current view tool will not be visible in the render.

Boolean DzPBufferView::renderThumbnail ( DzRenderHandler  handler  ) 

Performs a thumbnail-rendering operation through this view.

Parameters:
handler The render-handler for the operation.
Returns:
true on success, false on failure.

void DzPBufferView::resetCamera (  ) 

Reset's the view's camera.

void DzPBufferView::resize ( Size  size  ) 

Resizes the view.

Parameters:
size The new size of the view.

void DzPBufferView::setAxesOn ( Boolean  onOff  ) 

Sets whether or not to draw the world-space axes when rendering the scene.

Parameters:
onOff If true, the axes are drawn, otherwise, the axes will not be visible.

void DzPBufferView::setBackground ( Color  color  ) 

Sets the background color for the view.

Parameters:
color The new background color for the view.

void DzPBufferView::setCamera ( DzCamera  cam  ) 

Sets the camera that the view will be rendered through

Parameters:
cam The camera that the view will render through. This object should be owned by the scene, or by the caller. It is expected that this object remain valid as long as the view is using it.

void DzPBufferView::setDrawStyle ( DzDrawStyle  style  ) 

Sets the drawstyle used by the view when rendering the scene.

Parameters:
style The new drawstyle for the view. The view takes ownership of this object and deletes it when it is no longer used.

void DzPBufferView::setFloorOn ( Boolean  onOff  ) 

Sets whether or not to draw the floor when rendering the scene.

Parameters:
onOff If true, the floor is drawn, otherwise, the floor will not be visible.

Size DzPBufferView::size (  ) 

Returns:
The current size of the view.

void DzPBufferView::sizeChanged ( Size  size  )  [signal]

Signature: "sizeChanged(const QSize&)"

Emitted when the size of the view has been changed.

void DzPBufferView::viewChanged (  )  [signal]

Signature: "viewChanged()"

Emitted when the view has changed.


Generated on Thu Sep 24 12:21:14 2009

Copyright © 2002 - 2009 DAZ 3D, Inc.