QGIS API Documentation  2.12.0-Lyon
Public Member Functions | List of all members
QgsSymbolV2RenderContext Class Reference

#include <qgssymbolv2.h>

Public Member Functions

 QgsSymbolV2RenderContext (QgsRenderContext &c, QgsSymbolV2::OutputUnit u, qreal alpha=1.0, bool selected=false, int renderHints=0, const QgsFeature *f=0, const QgsFields *fields=0, const QgsMapUnitScale &mapUnitScale=QgsMapUnitScale())
 
 ~QgsSymbolV2RenderContext ()
 
qreal alpha () const
 Get alpha transparency 1 for opaque, 0 for invisible. More...
 
const QgsFeaturefeature () const
 Current feature being rendered - may be null. More...
 
const QgsFieldsfields () const
 Fields of the layer. More...
 
QgsMapUnitScale mapUnitScale () const
 
QgsSymbolV2RenderContextoperator= (const QgsSymbolV2RenderContext &)
 
double outputLineWidth (double width) const
 
double outputPixelSize (double size) const
 
QgsSymbolV2::OutputUnit outputUnit () const
 
QgsRenderContextrenderContext ()
 
const QgsRenderContextrenderContext () const
 
int renderHints () const
 
bool selected () const
 
void setAlpha (qreal alpha)
 Set alpha transparency 1 for opaque, 0 for invisible. More...
 
void setFeature (const QgsFeature *f)
 
void setMapUnitScale (const QgsMapUnitScale &scale)
 
void setOriginalValueVariable (const QVariant &value)
 Sets the original value variable value for data defined symbology. More...
 
void setOutputUnit (QgsSymbolV2::OutputUnit u)
 
void setRenderHints (int hints)
 
void setSelected (bool selected)
 

Detailed Description

Definition at line 248 of file qgssymbolv2.h.

Constructor & Destructor Documentation

QgsSymbolV2RenderContext::QgsSymbolV2RenderContext ( QgsRenderContext c,
QgsSymbolV2::OutputUnit  u,
qreal  alpha = 1.0,
bool  selected = false,
int  renderHints = 0,
const QgsFeature f = 0,
const QgsFields fields = 0,
const QgsMapUnitScale mapUnitScale = QgsMapUnitScale() 
)

Definition at line 496 of file qgssymbolv2.cpp.

QgsSymbolV2RenderContext::~QgsSymbolV2RenderContext ( )

Definition at line 502 of file qgssymbolv2.cpp.

Member Function Documentation

qreal QgsSymbolV2RenderContext::alpha ( ) const
inline

Get alpha transparency 1 for opaque, 0 for invisible.

Definition at line 271 of file qgssymbolv2.h.

const QgsFeature* QgsSymbolV2RenderContext::feature ( ) const
inline

Current feature being rendered - may be null.

Definition at line 283 of file qgssymbolv2.h.

const QgsFields* QgsSymbolV2RenderContext::fields ( void  ) const
inline

Fields of the layer.

Currently only available in startRender() calls to allow symbols with data-defined properties prepare the expressions (other times fields() returns null)

Note
added in 2.4

Definition at line 289 of file qgssymbolv2.h.

QgsMapUnitScale QgsSymbolV2RenderContext::mapUnitScale ( ) const
inline

Definition at line 267 of file qgssymbolv2.h.

QgsSymbolV2RenderContext & QgsSymbolV2RenderContext::operator= ( const QgsSymbolV2RenderContext )

Definition at line 522 of file qgssymbolv2.cpp.

double QgsSymbolV2RenderContext::outputLineWidth ( double  width) const

Definition at line 512 of file qgssymbolv2.cpp.

double QgsSymbolV2RenderContext::outputPixelSize ( double  size) const

Definition at line 517 of file qgssymbolv2.cpp.

QgsSymbolV2::OutputUnit QgsSymbolV2RenderContext::outputUnit ( ) const
inline

Definition at line 264 of file qgssymbolv2.h.

QgsRenderContext& QgsSymbolV2RenderContext::renderContext ( )
inline

Definition at line 254 of file qgssymbolv2.h.

const QgsRenderContext& QgsSymbolV2RenderContext::renderContext ( ) const
inline

Definition at line 255 of file qgssymbolv2.h.

int QgsSymbolV2RenderContext::renderHints ( ) const
inline

Definition at line 278 of file qgssymbolv2.h.

bool QgsSymbolV2RenderContext::selected ( ) const
inline

Definition at line 275 of file qgssymbolv2.h.

void QgsSymbolV2RenderContext::setAlpha ( qreal  alpha)
inline

Set alpha transparency 1 for opaque, 0 for invisible.

Definition at line 273 of file qgssymbolv2.h.

void QgsSymbolV2RenderContext::setFeature ( const QgsFeature f)
inline

Definition at line 281 of file qgssymbolv2.h.

void QgsSymbolV2RenderContext::setMapUnitScale ( const QgsMapUnitScale scale)
inline

Definition at line 268 of file qgssymbolv2.h.

void QgsSymbolV2RenderContext::setOriginalValueVariable ( const QVariant value)

Sets the original value variable value for data defined symbology.

Parameters
valuevalue for original value variable. This usually represents the symbol property value before any data defined overrides have been applied.
Note
added in QGIS 2.12

Definition at line 507 of file qgssymbolv2.cpp.

void QgsSymbolV2RenderContext::setOutputUnit ( QgsSymbolV2::OutputUnit  u)
inline

Definition at line 265 of file qgssymbolv2.h.

void QgsSymbolV2RenderContext::setRenderHints ( int  hints)
inline

Definition at line 279 of file qgssymbolv2.h.

void QgsSymbolV2RenderContext::setSelected ( bool  selected)
inline

Definition at line 276 of file qgssymbolv2.h.


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