castor3d::ControlStyle Class Reference

#include <StyleControl.hpp>

Inheritance diagram for castor3d::ControlStyle:

Collaboration diagram for castor3d::ControlStyle:

Public Member Functions
virtual C3D_API	~ControlStyle () noexcept=default
	ControlStyle (ControlType type, castor::String const &name, Scene *scene, Engine &engine, MouseCursor cursor=MouseCursor::eArrow)
void	setBackgroundMaterial (MaterialObs value)
void	setForegroundMaterial (MaterialObs value)
void	setCursor (MouseCursor value) noexcept
void	setBackgroundInvisible (bool value) noexcept
void	setForegroundInvisible (bool value) noexcept
bool	isBackgroundInvisible () const noexcept
bool	isForegroundInvisible () const noexcept
MaterialObs	getBackgroundMaterial () const noexcept
MaterialObs	getForegroundMaterial () const noexcept
ControlType	getType () const noexcept
MouseCursor	getCursor () const noexcept
Engine &	getEngine () const noexcept
bool	hasScene () const noexcept
Scene &	getScene () const noexcept
Public Member Functions inherited from castor::NamedBaseT< T >
	NamedBaseT (T name) noexcept
	Constructor.
T const &	getName () const noexcept
	Retrieves the name.
void	rename (T name) noexcept

Protected Member Functions
MaterialObs	doCreateMaterial (MaterialObs material, float offset, castor::String const &suffix) const

Additional Inherited Members
Protected Attributes inherited from castor::NamedBaseT< T >
T	m_name

Constructor & Destructor Documentation

~ControlStyle()

virtual C3D_API castor3d::ControlStyle::~ControlStyle ( )

virtualdefaultnoexcept

ControlStyle()

castor3d::ControlStyle::ControlStyle ( ControlType type, castor::String const & name, Scene * scene, Engine & engine, MouseCursor cursor = MouseCursor::eArrow )

inline

Member Function Documentation

doCreateMaterial()

MaterialObs castor3d::ControlStyle::doCreateMaterial ( MaterialObs material, float offset, castor::String const & suffix ) const

inlineprotected

References castor::RgbColourT< ComponentType >::blue(), castor3d::createMaterial(), getEngine(), castor3d::getMaterialColour(), castor::NamedBaseT< T >::getName(), castor3d::Material::getPass(), castor::RgbColourT< ComponentType >::green(), and castor::RgbColourT< ComponentType >::red().

Here is the call graph for this function:

getBackgroundMaterial()

MaterialObs castor3d::ControlStyle::getBackgroundMaterial ( ) const

inlinenoexcept

getCursor()

MouseCursor castor3d::ControlStyle::getCursor ( ) const

inlinenoexcept

getEngine()

Engine & castor3d::ControlStyle::getEngine ( ) const

inlinenoexcept

Referenced by doCreateMaterial().

Here is the caller graph for this function:

getForegroundMaterial()

MaterialObs castor3d::ControlStyle::getForegroundMaterial ( ) const

inlinenoexcept

Referenced by castor3d::ProgressStyle::getTextMaterial().

Here is the caller graph for this function:

getScene()

Scene & castor3d::ControlStyle::getScene ( ) const

inlinenoexcept

References CU_Require, and hasScene().

Here is the call graph for this function:

getType()

ControlType castor3d::ControlStyle::getType ( ) const

inlinenoexcept

hasScene()

bool castor3d::ControlStyle::hasScene ( ) const

inlinenoexcept

Referenced by getScene().

Here is the caller graph for this function:

isBackgroundInvisible()

bool castor3d::ControlStyle::isBackgroundInvisible ( ) const

inlinenoexcept

isForegroundInvisible()

bool castor3d::ControlStyle::isForegroundInvisible ( ) const

inlinenoexcept

setBackgroundInvisible()

void castor3d::ControlStyle::setBackgroundInvisible ( bool value )

inlinenoexcept

Referenced by castor3d::FrameStyle::FrameStyle(), and castor3d::ProgressStyle::ProgressStyle().

Here is the caller graph for this function:

setBackgroundMaterial()

void castor3d::ControlStyle::setBackgroundMaterial ( MaterialObs value )

inline

setCursor()

void castor3d::ControlStyle::setCursor ( MouseCursor value )

inlinenoexcept

setForegroundInvisible()

void castor3d::ControlStyle::setForegroundInvisible ( bool value )

inlinenoexcept

Referenced by castor3d::FrameStyle::FrameStyle().

Here is the caller graph for this function:

setForegroundMaterial()

void castor3d::ControlStyle::setForegroundMaterial ( MaterialObs value )

inline

---

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

• Castor3D/Gui/Theme/StyleControl.hpp