Workspace 6.21.5
Public Member Functions | List of all members
ColorStateShader Class Reference

A shader that interprets a node state as a RGBA color for each node.

#include <Rendering/SceneComponents/Shaders/colorstateshader.h>

Inheritance diagram for ColorStateShader:
[legend]

Public Member Functions

 ColorStateShader ()
 
 ColorStateShader (const ColorStateShader &shader)
 
 ~ColorStateShader () override
 
bool appliesScreenSpaceAmbientOcclusion () override
 
bool appliesSpecular () override
 
bool appliesTransparency () const override
 
ColorStateShaderclone () const override
 
bool getLightingEnabled () const
 
const QString & getStateName () const
 
SurfaceRepresentation getSurfaceRepresentation () const
 
bool isBgrMode () const
 
ColorStateShaderoperator= (const ColorStateShader &shader)
 
void setAppliesTransparency (bool enable)
 
void setBgrMode (bool bgr)
 
void setLightingEnabled (bool enable)
 
void setStateName (const QString &name)
 
void setSurfaceRepresentation (SurfaceRepresentation r)
 
- Public Member Functions inherited from TypedShader< ColorStateShader >
 ~TypedShader () override=default
 
- Public Member Functions inherited from Shader
 ~Shader () override
 
bool activate (SceneRenderer &renderer)
 Activates the shader on the target WSGLRenderer in preparation for drawing an object.
 
virtual bool appliesScreenSpaceAmbientOcclusion ()
 
virtual bool appliesSpecular ()
 
virtual bool appliesTransparency () const =0
 
Shaderclone () const override=0
 
bool deactivate (SceneRenderer &renderer)
 Deactivates the shader on the target WSGLRenderer, setting it back to the state it was in before the shader was bound.
 
int getId () const
 
Mesh::MeshModelSource::MeshModelInterfaceLockedPtr getMeshModelInterface (const QString &modelId, Mesh::MeshModelLibrary &modelLib)
 
bool getModelSourceUpdateRequested () const
 
bool getOptimizeOutInternalVolumeElements () const
 
double getSegmentLineWidth () const
 
virtual TexturizergetTexturizer ()
 
virtual const TexturizergetTexturizer () const
 
bool renderCurrentModel (SceneRenderer &renderer)
 Renders the model currently being processed by the specified renderer.s.
 
bool renderCurrentModelGlyphs (SceneRenderer &renderer)
 
void setOptimizeOutInternalVolumeElements (bool val)
 
void setSegmentLineWidth (double width)
 
- Public Member Functions inherited from Clonable
virtual ~Clonable ()=default
 
virtual Clonableclone () const =0
 

Additional Inherited Members

- Static Public Member Functions inherited from TypedShader< ColorStateShader >
static void registerImplementation (const SceneRendererTypeId &rendererId, const ShaderImplementationFactory &factory)
 
- Protected Member Functions inherited from TypedShader< ColorStateShader >
 TypedShader ()
 
 TypedShader (const TypedShader &shader)
 
TypedShaderclone () const override=0
 
- Protected Member Functions inherited from Shader
 Shader ()
 
 Shader (const Shader &shader)
 
void addImplementation (const SceneRendererContext &context, ShaderImplementation &impl)
 
void setId (int id)
 

Constructor & Destructor Documentation

◆ ColorStateShader() [1/2]

◆ ColorStateShader() [2/2]

ColorStateShader ( const ColorStateShader shader)

◆ ~ColorStateShader()

~ColorStateShader ( )
override

Member Function Documentation

◆ appliesScreenSpaceAmbientOcclusion()

bool appliesScreenSpaceAmbientOcclusion ( )
inlineoverridevirtual

Sub-classes only need to overide this if they can apply Screen Space Ambient Occlusion

Reimplemented from Shader.

◆ appliesSpecular()

bool appliesSpecular ( )
inlineoverridevirtual

Sub-classes only need to overide this if they apply specular high-lights (eg. Blinn-Phong).

Reimplemented from Shader.

◆ appliesTransparency()

bool appliesTransparency ( ) const
overridevirtual

Subclasses must override this to specify whether they apply transparency to objects or not when they are enabled.

Implements Shader.

◆ clone()

ColorStateShader * clone ( ) const
overridevirtual
Returns
A clone of this object.
Note
Subclasses would normally return their own type rather than the Clonable type. The C++ language rules allow a more derived type to be returned from a virtual function and the compiler will still treat it as a valid override.

Implements TypedShader< ColorStateShader >.

◆ getLightingEnabled()

bool getLightingEnabled ( ) const

◆ getStateName()

const QString & getStateName ( ) const

◆ getSurfaceRepresentation()

SurfaceRepresentation getSurfaceRepresentation ( ) const

◆ isBgrMode()

bool isBgrMode ( ) const

Use BGR instead of default RGB order

◆ operator=()

ColorStateShader & operator= ( const ColorStateShader shader)

◆ setAppliesTransparency()

void setAppliesTransparency ( bool  enable)

◆ setBgrMode()

void setBgrMode ( bool  bgr)

Switch to BGR instead of default RGB order

◆ setLightingEnabled()

void setLightingEnabled ( bool  enable)

◆ setStateName()

void setStateName ( const QString &  name)

◆ setSurfaceRepresentation()

void setSurfaceRepresentation ( SurfaceRepresentation  r)