Ufe::Light_v5_5 Class Reference

Class for new light types. More...

#include <light.h>

Inheritance diagram for Ufe::Light_v5_5:

Collaboration diagram for Ufe::Light_v5_5:

Classes
class	CylinderInterface
class	DiskInterface
class	DomeInterface
struct	VolumeProps

Public Types
typedef std::shared_ptr< Light_v5_5 >	Ptr
using	VolumePropsUndoableCommand = SetValueUndoableCommand< const VolumeProps & >
Public Types inherited from Ufe::Light
enum	Type {   Invalid , Directional , Point , Spot ,   Area , Sphere , Cylinder , Disk ,   Dome }
typedef std::shared_ptr< Light >	Ptr
using	IntensityUndoableCommand = SetFloatUndoableCommand
using	ColorUndoableCommand = SetColor3fUndoableCommand
using	ShadowEnableUndoableCommand = SetBoolUndoableCommand
using	ShadowColorUndoableCommand = SetColor3fUndoableCommand
using	DiffuseUndoableCommand = SetFloatUndoableCommand
using	SpecularUndoableCommand = SetFloatUndoableCommand
using	AngleUndoableCommand = SetFloatUndoableCommand
using	SpherePropsUndoableCommand = SetValueUndoableCommand< const SphereProps & >
using	ConePropsUndoableCommand = SetValueUndoableCommand< const ConeProps & >
using	NormalizeUndoableCommand = SetBoolUndoableCommand

Public Member Functions
	Light_v5_5 ()
	Constructor. More...
	Light_v5_5 (const Light_v5_5 &)=default
	Default copy constructor. More...
virtual	~Light_v5_5 () override
std::shared_ptr< CylinderInterface >	cylinderInterface ()
std::shared_ptr< DiskInterface >	diskInterface ()
std::shared_ptr< DomeInterface >	domeInterface ()
Public Member Functions inherited from Ufe::Light
	Light ()
	Constructor. More...
	Light (const Light &)=default
	Default copy constructor. More...
virtual	~Light ()
	Destructor. More...
virtual const Path &	path () const =0
virtual SceneItem::Ptr	sceneItem () const =0
virtual Type	type () const =0
virtual IntensityUndoableCommand::Ptr	intensityCmd (float li)=0
virtual void	intensity (float li)
virtual float	intensity () const =0
virtual ColorUndoableCommand::Ptr	colorCmd (float r, float g, float b)=0
virtual void	color (float r, float g, float b)
virtual Color3f	color () const =0
virtual ShadowEnableUndoableCommand::Ptr	shadowEnableCmd (bool se)=0
virtual void	shadowEnable (bool se)
virtual bool	shadowEnable () const =0
virtual ShadowColorUndoableCommand::Ptr	shadowColorCmd (float r, float g, float b)=0
virtual void	shadowColor (float r, float g, float b)
virtual Color3f	shadowColor () const =0
virtual DiffuseUndoableCommand::Ptr	diffuseCmd (float ld)=0
virtual void	diffuse (float ld)
virtual float	diffuse () const =0
virtual SpecularUndoableCommand::Ptr	specularCmd (float ls)=0
virtual void	specular (float ls)
virtual float	specular () const =0
std::shared_ptr< DirectionalInterface >	directionalInterface ()
std::shared_ptr< SphereInterface >	sphereInterface ()
std::shared_ptr< ConeInterface >	coneInterface ()
std::shared_ptr< AreaInterface >	areaInterface ()

Static Public Member Functions
static Ptr	light (const SceneItem::Ptr &item)
Static Public Member Functions inherited from Ufe::Light
static Ptr	light (const SceneItem::Ptr &item)
static bool	addObserver (const SceneItem::Ptr &item, const Observer::Ptr &obs)
static bool	removeObserver (const SceneItem::Ptr &item, const Observer::Ptr &obs)
static std::size_t	nbObservers (const SceneItem::Ptr &item)
static bool	hasObserver (const SceneItem::Ptr &item, const Observer::Ptr &obs)
static bool	hasObservers (const Path &path)
static bool	hasObservers (Rtid runTimeId)
static void	notify (const Path &path)

Protected Member Functions
virtual std::shared_ptr< CylinderInterface >	cylinderInterfaceImpl ()=0
virtual std::shared_ptr< DiskInterface >	diskInterfaceImpl ()=0
virtual std::shared_ptr< DomeInterface >	domeInterfaceImpl ()=0
Protected Member Functions inherited from Ufe::Light
virtual std::shared_ptr< DirectionalInterface >	directionalInterfaceImpl ()=0
virtual std::shared_ptr< SphereInterface >	sphereInterfaceImpl ()=0
virtual std::shared_ptr< ConeInterface >	coneInterfaceImpl ()=0
virtual std::shared_ptr< AreaInterface >	areaInterfaceImpl ()=0

Detailed Description

Class for new light types.

To access interfaces that are appropriate for different light types, the Light_v5_5 interface provides accessors to sub-interfaces:

• CylinderInterface
• DiskInterface
• DomeInterface

See also

Light

Definition at line 476 of file light.h.

Member Typedef Documentation

Ptr

typedef std::shared_ptr<Light_v5_5> Ufe::Light_v5_5::Ptr

Definition at line 479 of file light.h.

VolumePropsUndoableCommand

using Ufe::Light_v5_5::VolumePropsUndoableCommand = SetValueUndoableCommand<const VolumeProps&>

Definition at line 487 of file light.h.

Constructor & Destructor Documentation

Light_v5_5() [1/2]

Ufe::Light_v5_5::Light_v5_5

(

)

Constructor.

Light_v5_5() [2/2]

Ufe::Light_v5_5::Light_v5_5 ( const Light_v5_5 &  )

default

Default copy constructor.

~Light_v5_5()

virtual Ufe::Light_v5_5::~Light_v5_5 ( )

overridevirtual

Member Function Documentation

cylinderInterface()

std::shared_ptr< CylinderInterface > Ufe::Light_v5_5::cylinderInterface

(

)

Retrieve the cylinder interface for the light

Returns

the cylinder interface

cylinderInterfaceImpl()

virtual std::shared_ptr< CylinderInterface > Ufe::Light_v5_5::cylinderInterfaceImpl ( )

protectedpure virtual

diskInterface()

std::shared_ptr< DiskInterface > Ufe::Light_v5_5::diskInterface

(

)

Retrieve the disk interface for the light

Returns

the disk interface

diskInterfaceImpl()

virtual std::shared_ptr< DiskInterface > Ufe::Light_v5_5::diskInterfaceImpl ( )

protectedpure virtual

domeInterface()

std::shared_ptr< DomeInterface > Ufe::Light_v5_5::domeInterface

(

)

Retrieve the dome interface for the light

Returns

the dome interface

domeInterfaceImpl()

virtual std::shared_ptr< DomeInterface > Ufe::Light_v5_5::domeInterfaceImpl ( )

protectedpure virtual

light()

static Ptr Ufe::Light_v5_5::light ( const SceneItem::Ptr &  item )

static

---

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

• common/include/ufe/light.h