ARB: ShaderPlugin Class Reference

ARB

#include <item_shader.h>

Inheritance diagram for ShaderPlugin:

Inheritance graph

Public Member Functions
	ShaderPlugin (const std::string &id_, const std::string &description_)

virtual	~ShaderPlugin ()

void	announce_shader (ItemShader *shader)

const std::string &	get_id () const

const std::string &	get_description () const

const char *	get_shader_local_id () const

void	init_awars (AW_root awr, const char awar_prefix_)

const char *	plugin_awar (const char *name) const

const char *	dimension_awar (int dim, const char *name) const

bool	overlay_marked () const

bool	overlay_color_groups () const

virtual ShadedValue	shade (GBDATA *gb_item) const =0

virtual int	get_dimension () const =0

virtual bool	customizable () const =0

virtual void	customize (AW_root *awr)=0

virtual char *	store_config () const =0

virtual void	load_or_reset_config (const char *cfgstr)=0

virtual void	activate (bool on)=0

void	trigger_reshade_if_active_cb (ReshadeMode mode)

Protected Member Functions
const ItemShader *	shader_plugged_into () const

Detailed Description

Definition at line 188 of file item_shader.h.

Constructor & Destructor Documentation

ShaderPlugin::ShaderPlugin	(	const std::string &	id_,
		const std::string &	description_
	)

inline

construct a shader plugin

Parameters

id_	a unique id
description_	description of plugin (ia. used as title of config window)

Definition at line 201 of file item_shader.h.

virtual ShaderPlugin::~ShaderPlugin ( )

inlinevirtual

Definition at line 211 of file item_shader.h.

Member Function Documentation

const ItemShader* ShaderPlugin::shader_plugged_into ( ) const

inlineprotected

Definition at line 198 of file item_shader.h.

void ShaderPlugin::announce_shader ( ItemShader * shader )

inline

Definition at line 213 of file item_shader.h.

const std::string& ShaderPlugin::get_id ( ) const

inline

Definition at line 215 of file item_shader.h.

Referenced by get_shader_local_id(), ItemShader::is_active_plugin(), and has_id::operator()().

const std::string& ShaderPlugin::get_description ( ) const

inline

Definition at line 216 of file item_shader.h.

const char * ShaderPlugin::get_shader_local_id ( ) const

inline

Definition at line 357 of file item_shader.h.

References GBS_global_string(), get_id(), ItemShader::get_id(), and is_assert.

void ShaderPlugin::init_awars	(	AW_root *	awr,
		const char *	awar_prefix_
	)

Definition at line 125 of file item_shader.cxx.

References AW_root::awar_float(), AW_root::awar_int(), AWAR_PLUGIN_OVERLAY_GROUPS, AWAR_PLUGIN_OVERLAY_MARKED, AWAR_PLUGIN_PHASE_ALTER, AWAR_PLUGIN_PHASE_FREQ, AWAR_PLUGIN_PHASE_POSTSHIFT, AWAR_PLUGIN_PHASE_PRESHIFT, AWAR_PLUGIN_RANGE, AW_root::awar_string(), is_assert, and string().

const char* ShaderPlugin::plugin_awar ( const char * name ) const

inline

Definition at line 221 of file item_shader.h.

References GBS_global_string(), and is_assert.

const char* ShaderPlugin::dimension_awar	(	int	dim,
		const char *	name
	)		const

inline

Definition at line 225 of file item_shader.h.

References GBS_global_string(), and is_assert.

bool ShaderPlugin::overlay_marked ( ) const

Definition at line 143 of file item_shader.cxx.

References AW_root::awar(), AWAR_PLUGIN_OVERLAY_MARKED, AW_awar::read_int(), and AW_root::SINGLETON.

Referenced by ItemShader::overlay_marked().

bool ShaderPlugin::overlay_color_groups ( ) const

Definition at line 146 of file item_shader.cxx.

References AW_root::awar(), AWAR_PLUGIN_OVERLAY_GROUPS, AW_awar::read_int(), and AW_root::SINGLETON.

Referenced by ItemShader::overlay_color_groups().

virtual ShadedValue ShaderPlugin::shade ( GBDATA * gb_item ) const

pure virtual

Implemented in ItemFieldShader, and TopologyShader.

Referenced by ItemShader::shade().

virtual int ShaderPlugin::get_dimension ( ) const

pure virtual

Implemented in ItemFieldShader, and TopologyShader.

virtual bool ShaderPlugin::customizable ( ) const

pure virtual

Implemented in ItemFieldShader, and TopologyShader.

virtual void ShaderPlugin::customize ( AW_root * awr )

pure virtual

Implemented in ItemFieldShader, and TopologyShader.

virtual char* ShaderPlugin::store_config ( ) const

pure virtual

Implemented in ItemFieldShader, and TopologyShader.

virtual void ShaderPlugin::load_or_reset_config ( const char * cfgstr )

pure virtual

Implemented in ItemFieldShader, and TopologyShader.

virtual void ShaderPlugin::activate ( bool on )

pure virtual

Implemented in ItemFieldShader, and TopologyShader.

void ShaderPlugin::trigger_reshade_if_active_cb ( ReshadeMode mode )

inline

Definition at line 361 of file item_shader.h.

References ItemShader::is_active_plugin(), and ItemShader::trigger_reshade_callback().

Referenced by TopologyShader::tree_changed_cb().

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

SL/ITEM_SHADER/item_shader.h
SL/ITEM_SHADER/item_shader.cxx