User Tools

Site Tools


DzDrawStyle

Encapsulates the drawing parameters for a 3D view.

More...

Inherits :

Inherited By : DzUserDrawStyle

Enumerations

Properties

Methods

Detailed Description

TODO: Add detailed description.

Enumerations


: ShadeStyle

A list of shading styles for rendering scene objects in OpenGL

  • WireBox - Draws unlit wire-frame bounding boxes
  • SolidBox - Draws smooth-shaded bounding boxes
  • Wireframe - Draws unlit wire-frames
  • LitWireframe - Draws lit wire-frames
  • HiddenLine - Draws unlit wire-frames, front geometry facing only
  • WireShaded - Draws lit smooth shaded objects with wireframes imposed
  • SmoothShaded - Draws lit smooth shaded objects
  • WireTextured - Draws lit smooth shaded objects with any texture/transparency maps applied and wireframes imposed
  • Textured - Draws lit smooth shaded objects with any texture/transparency maps applied
  • GLSLShader - Draws lit smooth shaded objects with a GLSL shader applied
  • Unshaded - Draws unlit smooth shaded objects
  • Picking - Special mode for using OpenGL to determine a selected object when the user clicks in the view

Properties


Boolean : drawCuesDefault

Whether or not visual cues (such as bounding boxes for selected nodes) should be drawn when appropriate.


Boolean : drawObjectsOnly

Whether or not only objects should be drawn


Boolean : drawShadowCastersOnly

Whether or not only shadow casters should be drawn


Boolean : isUserStyle

Read-Only - Whether or not the style is a user style


Boolean : renderQuality

Whether or not the draw is render quality.

Methods


Boolean : drawCues()

Return Value:

  • true if visual cues (such as bounding boxes for selected nodes) should be drawn for the current drawing operation, false if visual cues should not be drawn.

See Also:

  • setDrawCuesDefault(), getDrawCuesDefault()

void : forceUseLighting()

If the current shade style is not using lighting, this method will set the shade style to the nearest match that uses single-pass drawing and lighting.


Number : pass()

Return Value:

  • The current pass number (second passes are draw for the hidden line and wire shaded styles)

See Also:

  • setPass()

Boolean : selectionMapsEnabled()

Return Value:

  • true if selection maps are enabled, false if selection maps are disabled. This is only valid for node picking draw operations.

See Also:

  • setRenderQuality()

sceneshader_dz : shader()

Return Value:

  • The scene shader for this draw operation, if any.

ShadeStyle : shadeStyle()

Return Value:

  • The shading style for the current drawing operation