Free Electron
Public Member Functions | List of all members
fe::ext::DrawNull Class Reference

Draw nothing for DrawI, elegantly. More...

#include <DrawNull.h>

Inheritance diagram for fe::ext::DrawNull:
Inheritance graph
[legend]

Public Member Functions

virtual BWORD isDirect (void) const
 Returns TRUE is display is local and rendered directly. More...
 
virtual void setDrawMode (sp< DrawMode > spDrawMode)
 Set rendering mode. More...
 
virtual sp< DrawModedrawMode (void) const
 Get rendering mode. More...
 
virtual void pushDrawMode (sp< DrawMode > mode)
 Push rendering mode onto stack. More...
 
virtual sp< DrawModepopDrawMode (void)
 Pop rendering mode from stack. More...
 
virtual void pushMatrixState (void)
 Push transform matrices. More...
 
virtual void popMatrixState (void)
 Pop transform matrices. More...
 
virtual void pushMatrix (MatrixMode a_mode, Real a_values[16])
 push a new 4x4 matrix on a particular stack More...
 
virtual void popMatrix (MatrixMode a_mode)
 pop the top 4x4 matrix from a particular stack More...
 
virtual void unbindVertexArray (void)
 currently, sets vertex array to zero in OpenGL More...
 
virtual void setBrightness (Real a_brightness)
 set additive lightening More...
 
virtual Real brightness (void)
 get lightening More...
 
virtual void setContrast (Real a_contrast)
 set multiplicitive light scaling More...
 
virtual Real contrast (void)
 get light scaling More...
 
virtual void setView (sp< ViewI > spViewI)
 Set current view. More...
 
virtual sp< ViewIview (void) const
 Get current view. More...
 
virtual void setDrawChain (sp< DrawI > a_spDrawI)
 Set next DrawI in a chain. More...
 
virtual sp< DrawIdrawChain (void)
 
virtual void setTransform (const SpatialTransform &a_rTransform)
 Impose a spatial translation. More...
 
virtual void flush (void)
 Called once after each frame. More...
 
virtual void flushLive (void)
 Pass on current input data as is. More...
 
virtual void clearInput (void)
 Reset the current input queue. More...
 
virtual BWORD empty (void) const
 Returns TRUE if the current input queue is empty. More...
 
virtual sp< FontIfont (void)
 Get current font. More...
 
virtual Real multiplication (void)
 Select the GL-specific index/handle. More...
 
virtual void drawPoints (const SpatialVector *vertex, const SpatialVector *normal, U32 vertices, BWORD multicolor, const Color *color)
 Draw points vertex[vertices]. More...
 
virtual void drawPoints (const SpatialVector *vertex, const SpatialVector *normal, U32 vertices, BWORD multicolor, const Color *color, sp< DrawBufferI > spDrawBuffer)
 
virtual void drawLines (const SpatialVector *vertex, const SpatialVector *normal, U32 vertices, StripMode strip, BWORD multicolor, const Color *color)
 Draw lines. More...
 
virtual void drawLines (const SpatialVector *vertex, const SpatialVector *normal, U32 vertices, StripMode strip, BWORD multicolor, const Color *color, BWORD multiradius, const Real *radius, const Vector3i *element, U32 elementCount, sp< DrawBufferI > spDrawBuffer)
 
virtual void drawCurve (const SpatialVector *vertex, const SpatialVector *normal, const Real *radius, U32 vertices, BWORD multicolor, const Color *color)
 Draw one curve. More...
 
virtual void drawTriangles (const SpatialVector *vertex, const SpatialVector *normal, const Vector2 *texture, U32 vertices, StripMode strip, BWORD multicolor, const Color *color)
 Draw triangles. More...
 
virtual void drawTriangles (const SpatialVector *vertex, const SpatialVector *normal, const Vector2 *texture, U32 vertices, StripMode strip, BWORD multicolor, const Color *color, const Array< I32 > *vertexMap, const Array< I32 > *hullPointMap, const Array< Vector4i > *hullFacePoint, sp< DrawBufferI > spDrawBuffer)
 
virtual void drawRectangles (const SpatialVector *vertex, U32 vertices, BWORD multicolor, const Color *color)
 Draw rectangles. More...
 
virtual void draw (cp< DrawableI > cpDrawableI, const Color *color)
 Draw DrawableI. More...
 
virtual void draw (cp< DrawableI > cpDrawableI, const Color *color, sp< DrawBufferI > spDrawBuffer)
 
virtual void drawTransformed (const SpatialTransform &transform, cp< DrawableI > cpDrawableI, const Color *color)
 
virtual void drawTransformed (const SpatialTransform &transform, cp< DrawableI > cpDrawableI, const Color *color, sp< DrawBufferI > spDrawBuffer)
 
virtual void drawBox (const Box2 &box, const Color &color)
 Draw 2D box. More...
 
virtual void drawBox (const Box2i &box, const Color &color)
 Draw 2D box with pixel adjustments. More...
 
virtual void drawBox (const Box3 &box, const Color &color)
 Draw 3D box. More...
 
virtual void drawAlignedText (const SpatialVector &location, const String text, const Color &color)
 Draw screen-aligned single color text. More...
 
virtual void drawCircle (const SpatialTransform &transform, const SpatialVector *scale, const Color &color)
 
virtual void drawSphere (const SpatialTransform &transform, const SpatialVector *scale, const Color &color)
 
virtual void drawCylinder (const SpatialTransform &transform, const SpatialVector *scale, Real baseScale, const Color &color, U32 slices)
 Draw a transformed cylinder or cone. More...
 
virtual void drawCylinder (const SpatialVector &location1, const SpatialVector &location2, Real radius1, Real radius2, const Color &color, U32 slices)
 
virtual void drawCylinders (const SpatialTransform *transform, const SpatialVector *scale, const Real *baseScale, const U32 *slices, U32 cylinders, BWORD multicolor, const Color *color)
 
virtual void drawTransformedCylinders (const SpatialTransform &pretransform, const SpatialTransform *transform, const SpatialVector *scale, const Real *baseScale, const U32 *slices, U32 cylinders, BWORD multicolor, const Color *color)
 
virtual void drawArc (const SpatialTransform &transform, const SpatialVector *scale, Real startangle, Real endangle, const Color &color)
 
virtual void drawTransformedPoints (const SpatialTransform &transform, const SpatialVector *scale, const SpatialVector *vertex, const SpatialVector *normal, U32 vertices, BWORD multicolor, const Color *color)
 
virtual void drawTransformedPoints (const SpatialTransform &transform, const SpatialVector *scale, const SpatialVector *vertex, const SpatialVector *normal, U32 vertices, BWORD multicolor, const Color *color, sp< DrawBufferI > spDrawBuffer)
 
virtual void drawTransformedLines (const SpatialTransform &transform, const SpatialVector *scale, const SpatialVector *vertex, const SpatialVector *normal, U32 vertices, StripMode strip, BWORD multicolor, const Color *color)
 
virtual void drawTransformedLines (const SpatialTransform &transform, const SpatialVector *scale, const SpatialVector *vertex, const SpatialVector *normal, U32 vertices, StripMode strip, BWORD multicolor, const Color *color, BWORD multiradius, const Real *radius, const Vector3i *element, U32 elementCount, sp< DrawBufferI > spDrawBuffer)
 
virtual void drawTransformedCurve (const SpatialTransform &transform, const SpatialVector *scale, const SpatialVector *vertex, const SpatialVector *normal, const Real *radius, U32 vertices, BWORD multicolor, const Color *color)
 
virtual void drawTransformedTriangles (const SpatialTransform &transform, const SpatialVector *scale, const SpatialVector *vertex, const SpatialVector *normal, const Vector2 *texture, U32 vertices, StripMode strip, BWORD multicolor, const Color *color)
 
virtual void drawTransformedTriangles (const SpatialTransform &transform, const SpatialVector *scale, const SpatialVector *vertex, const SpatialVector *normal, const Vector2 *texture, U32 vertices, StripMode strip, BWORD multicolor, const Color *color, const Array< I32 > *vertexMap, const Array< I32 > *hullPointMap, const Array< Vector4i > *hullFacePoint, sp< DrawBufferI > spDrawBuffer)
 
virtual void drawTransformedBox (const SpatialTransform &transform, const Box3 &box, const Color &color)
 
virtual void drawTransformedBoxes (const SpatialTransform *transform, const SpatialVector *scale, U32 boxes, BWORD multicolor, const Color *color)
 
virtual void drawAxes (Real scale)
 
virtual void drawTransformedAxes (const SpatialTransform &transform, Real scale)
 
virtual void drawMarker (Real radius, const Color &color)
 
virtual void drawTransformedMarker (const SpatialTransform &transform, Real radius, const Color &color)
 
virtual void drawRaster (sp< ImageI > spImageI, const SpatialVector &location)
 
virtual sp< DrawBufferIcreateBuffer (void)
 
- Public Member Functions inherited from fe::Component
const Stringname (void) const
 Return the components chosen name. More...
 
const String verboseName (void) const
 Return the annotated chosen name. More...
 
void setName (const String &name)
 Rename the component to anything you want. More...
 
hp< Registryregistry (void) const
 Get the Registry that created this component. More...
 
void adjoin (sp< Component > spComponent)
 Tie this component's lifetime to another. More...
 
sp< Componentcreate (const String &implementation, BWORD quiet=FALSE) const
 Convienience function to registry()->create() More...
 
void disjoin (void)
 Untie component from Hub, if connected. More...
 
String factoryName (void)
 
void setLibrary (sp< Library > spLibrary)
 Store a reference to the library used to instantiate this component. More...
 
sp< Librarylibrary (void)
 Get the library that created the component. More...
 
void setFactoryIndex (I32 a_factoryIndex)
 Set the library's factory index. More...
 
I32 factoryIndex (void)
 Get the library's factory index. More...
 
void setSingleton (BWORD set)
 Specify whether component is a singleton. More...
 
BWORD isSingleton (void)
 Return whether component is a singleton. More...
 
virtual void acquire (void)
 Specialized reference increment. More...
 
virtual void release (void)
 Specialized reference decrement. More...
 
- Public Member Functions inherited from fe::Handled< Component >
const hp< Component > & getHandle (void) const
 Get a safe handle to this object. More...
 
- Public Member Functions inherited from fe::Protectable
virtual I32 protection (void) const
 
virtual void protect (void)
 
virtual void unprotect (void)
 
virtual Protectableclone (Protectable *pInstance=NULL)
 
- Public Member Functions inherited from fe::Counted
virtual void acquire (int &rCount)
 Increment the reference count (and get the count) More...
 
virtual void abandon (void)
 Decrement the reference count. More...
 
int count (void) const
 Return the count of references. More...
 
void setName (const String &)
 
void trackReference (void *pReference, String what)
 
void untrackReference (void *pReference)
 
void registerRegion (void *pT, U32 bytes)
 
- Public Member Functions inherited from fe::Initialized
void initializeAll (void)
 
void setActive (bool a_active)
 

Additional Inherited Members

- Public Types inherited from fe::ext::DrawI
enum  StripMode {
  e_discrete,
  e_strip,
  e_fan,
  e_triple
}
 Format of vertices for tri-stripping. More...
 
enum  MatrixMode {
  e_modelview,
  e_projection,
  e_texture,
  e_color
}
 
- Static Public Member Functions inherited from fe::Counted
static String reportTracker (void)
 
static U32 trackerCount (void)
 
- Protected Types inherited from fe::Initialized
typedef void(* InitializeFunction) (Initialized *)
 
- Protected Member Functions inherited from fe::Handled< Component >
void abandonHandle (void)
 
- Protected Member Functions inherited from fe::Counted
int releaseInternal (void)
 Decrement the reference count. More...
 
void suppressReport (void)
 
- Protected Member Functions inherited from fe::Initialized
void addInitializer (InitializeFunction function)
 

Detailed Description

Draw nothing for DrawI, elegantly.

Member Function Documentation

◆ brightness()

virtual Real fe::ext::DrawNull::brightness ( void  )
inlinevirtual

get lightening

Implements fe::ext::DrawI.

◆ clearInput()

virtual void fe::ext::DrawNull::clearInput ( void  )
inlinevirtual

Reset the current input queue.

Implements fe::ext::DrawI.

Reimplemented in fe::ext::DrawRayTrace.

◆ contrast()

virtual Real fe::ext::DrawNull::contrast ( void  )
inlinevirtual

get light scaling

Implements fe::ext::DrawI.

◆ draw()

virtual void fe::ext::DrawNull::draw ( cp< DrawableI cpDrawableI,
const Color color 
)
inlinevirtual

Draw DrawableI.

If color is NULL, the surface is expected to use its own color data.

Implements fe::ext::DrawI.

Reimplemented in fe::ext::DrawRayTrace.

Referenced by fe::ext::DrawRayTrace::drawCylinder().

◆ drawAlignedText()

virtual void fe::ext::DrawNull::drawAlignedText ( const SpatialVector location,
const String  text,
const Color color 
)
inlinevirtual

Draw screen-aligned single color text.

Text is drawn at the given location, transformed and projected by the current state of the underlying graphics system.

Implements fe::ext::DrawI.

Reimplemented in fe::ext::DrawRayTrace, and fe::ext::DrawConsole.

◆ drawBox() [1/3]

virtual void fe::ext::DrawNull::drawBox ( const Box2 box,
const Color color 
)
inlinevirtual

Draw 2D box.

Implements fe::ext::DrawI.

◆ drawBox() [2/3]

virtual void fe::ext::DrawNull::drawBox ( const Box2i box,
const Color color 
)
inlinevirtual

Draw 2D box with pixel adjustments.

Implements fe::ext::DrawI.

◆ drawBox() [3/3]

virtual void fe::ext::DrawNull::drawBox ( const Box3 box,
const Color color 
)
inlinevirtual

Draw 3D box.

Implements fe::ext::DrawI.

◆ drawCurve()

virtual void fe::ext::DrawNull::drawCurve ( const SpatialVector vertex,
const SpatialVector normal,
const Real *  radius,
U32  vertices,
BWORD  multicolor,
const Color color 
)
inlinevirtual

Draw one curve.

Uses vertices and colors as explained in drawPoints.

This is similar to drawLines in strip mode and with a radius property.

Implements fe::ext::DrawI.

◆ drawCylinder()

virtual void fe::ext::DrawNull::drawCylinder ( const SpatialTransform transform,
const SpatialVector scale,
Real  baseScale,
const Color color,
U32  slices 
)
inlinevirtual

Draw a transformed cylinder or cone.

The baseScale is a additional scale at the base of the cylinder. For a cone, specify a baseScale of 0.

Implements fe::ext::DrawI.

Reimplemented in fe::ext::DrawRayTrace, and fe::ext::DrawConsole.

◆ drawLines()

virtual void fe::ext::DrawNull::drawLines ( const SpatialVector vertex,
const SpatialVector normal,
U32  vertices,
StripMode  strip,
BWORD  multicolor,
const Color color 
)
inlinevirtual

Draw lines.

Uses vertices and colors as explained in drawPoints.

If strip is DrawI::e_strip, vertices are contiguous with vertices-1 segments, else vertices are independent pairs with vertices/2 segments.

Implements fe::ext::DrawI.

◆ drawMode()

virtual sp<DrawMode> fe::ext::DrawNull::drawMode ( void  ) const
inlinevirtual

Get rendering mode.

Implements fe::ext::DrawI.

◆ drawPoints()

virtual void fe::ext::DrawNull::drawPoints ( const SpatialVector vertex,
const SpatialVector normal,
U32  vertices,
BWORD  multicolor,
const Color color 
)
inlinevirtual

Draw points vertex[vertices].

The array vertex is assumed to contain vertices elements. If multicolor, points are independently colored with color[vertices], else only color[0] is used. If color is NULL, no colors are specified, so the current color state is left in effect.

Implements fe::ext::DrawI.

◆ drawRectangles()

virtual void fe::ext::DrawNull::drawRectangles ( const SpatialVector vertex,
U32  vertices,
BWORD  multicolor,
const Color color 
)
inlinevirtual

Draw rectangles.

Uses vertices and colors as explained in drawPoints.

Rectangles are never stripped.

Implements fe::ext::DrawI.

◆ drawTriangles()

virtual void fe::ext::DrawNull::drawTriangles ( const SpatialVector vertex,
const SpatialVector normal,
const Vector2 texture,
U32  vertices,
StripMode  strip,
BWORD  multicolor,
const Color color 
)
inlinevirtual

Draw triangles.

Uses vertices and colors as explained in drawPoints.

Normals are treated the same as vertices. If strip is DrawI::e_strip, vertices are tri-striped with vertices-2 triangles, else vertices are independent triplets with vertices/3 triangles.

Implements fe::ext::DrawI.

◆ empty()

virtual BWORD fe::ext::DrawNull::empty ( void  ) const
inlinevirtual

Returns TRUE if the current input queue is empty.

Implements fe::ext::DrawI.

◆ flush()

virtual void fe::ext::DrawNull::flush ( void  )
inlinevirtual

Called once after each frame.

This shifts data access to freeze the current input buffer and prepare a new empty input buffer.

The resulting output buffer is sent on to the next DrawI interface.

Implements fe::ext::DrawI.

Reimplemented in fe::ext::DrawRayTrace, and fe::ext::DrawConsole.

◆ flushLive()

virtual void fe::ext::DrawNull::flushLive ( void  )
inlinevirtual

Pass on current input data as is.

This sends the current input to the next DrawI interface without shifting buffers. The same input can still be written to afterwards.

Implements fe::ext::DrawI.

Reimplemented in fe::ext::DrawRayTrace.

◆ font()

virtual sp<FontI> fe::ext::DrawNull::font ( void  )
inlinevirtual

Get current font.

Implements fe::ext::DrawI.

◆ isDirect()

virtual BWORD fe::ext::DrawNull::isDirect ( void  ) const
inlinevirtual

Returns TRUE is display is local and rendered directly.

Implements fe::ext::DrawI.

◆ multiplication()

virtual Real fe::ext::DrawNull::multiplication ( void  )
inlinevirtual

Select the GL-specific index/handle.

An index of 0 indicates no font. upscaling preference, such as for high DPI

Implements fe::ext::DrawI.

◆ popDrawMode()

virtual sp<DrawMode> fe::ext::DrawNull::popDrawMode ( void  )
inlinevirtual

Pop rendering mode from stack.

Implements fe::ext::DrawI.

◆ popMatrix()

virtual void fe::ext::DrawNull::popMatrix ( MatrixMode  a_mode)
inlinevirtual

pop the top 4x4 matrix from a particular stack

Implements fe::ext::DrawI.

◆ popMatrixState()

virtual void fe::ext::DrawNull::popMatrixState ( void  )
inlinevirtual

Pop transform matrices.

Implements fe::ext::DrawI.

◆ pushDrawMode()

virtual void fe::ext::DrawNull::pushDrawMode ( sp< DrawMode mode)
inlinevirtual

Push rendering mode onto stack.

Implements fe::ext::DrawI.

◆ pushMatrix()

virtual void fe::ext::DrawNull::pushMatrix ( MatrixMode  a_mode,
Real  a_values[16] 
)
inlinevirtual

push a new 4x4 matrix on a particular stack

Implements fe::ext::DrawI.

◆ pushMatrixState()

virtual void fe::ext::DrawNull::pushMatrixState ( void  )
inlinevirtual

Push transform matrices.

Implements fe::ext::DrawI.

◆ setBrightness()

virtual void fe::ext::DrawNull::setBrightness ( Real  a_brightness)
inlinevirtual

set additive lightening

Implements fe::ext::DrawI.

◆ setContrast()

virtual void fe::ext::DrawNull::setContrast ( Real  a_contrast)
inlinevirtual

set multiplicitive light scaling

Implements fe::ext::DrawI.

◆ setDrawChain()

virtual void fe::ext::DrawNull::setDrawChain ( sp< DrawI a_spDrawI)
inlinevirtual

Set next DrawI in a chain.

If this DrawI is designed to pass drawing commands to another DrawI, such as for conversion or caching, this commands specifies that next component.

Any implementation may ignore this request.

Implements fe::ext::DrawI.

Reimplemented in fe::ext::DrawRayTrace.

◆ setDrawMode()

virtual void fe::ext::DrawNull::setDrawMode ( sp< DrawMode mode)
inlinevirtual

Set rendering mode.

Implements fe::ext::DrawI.

◆ setTransform()

virtual void fe::ext::DrawNull::setTransform ( const SpatialTransform a_rTransform)
inlinevirtual

Impose a spatial translation.

If supported, this adjusts the output in an implementation-specific manner.

Any implementation may ignore this request or just use part of the transform, such as translation only.

Implements fe::ext::DrawI.

Reimplemented in fe::ext::DrawRayTrace.

◆ setView()

virtual void fe::ext::DrawNull::setView ( sp< ViewI spViewI)
inlinevirtual

Set current view.

Implements fe::ext::DrawI.

◆ unbindVertexArray()

virtual void fe::ext::DrawNull::unbindVertexArray ( void  )
inlinevirtual

currently, sets vertex array to zero in OpenGL

Implements fe::ext::DrawI.

◆ view()

virtual sp<ViewI> fe::ext::DrawNull::view ( void  ) const
inlinevirtual

Get current view.

Implements fe::ext::DrawI.

Reimplemented in fe::ext::DrawRayTrace.

Referenced by fe::ext::DrawOpenGL::flush().


The documentation for this class was generated from the following file: