Ufe::AreaLightInterface Class Reference

#include <light2.h>

Inheritance diagram for Ufe::AreaLightInterface:

Collaboration diagram for Ufe::AreaLightInterface:

Public Types
typedef std::shared_ptr< AreaLightInterface >	Ptr
using	NormalizeUndoableCommand = SetBoolUndoableCommand
using	WidthUndoableCommand = SetFloatUndoableCommand
using	HeightUndoableCommand = SetFloatUndoableCommand
Public Types inherited from Ufe::LightInterface
typedef std::shared_ptr< LightInterface >	Ptr

Public Member Functions
	AreaLightInterface ()
	Constructor. More...
	AreaLightInterface (const AreaLightInterface &)=default
	Default copy constructor. More...
virtual	~AreaLightInterface () override
	Destructor. More...
virtual NormalizeUndoableCommand::Ptr	normalizeCmd (bool nl)=0
virtual void	normalize (bool nl)
virtual bool	normalize () const =0
virtual WidthUndoableCommand::Ptr	widthCmd (float w)=0
virtual void	width (float w)
virtual float	width () const =0
virtual HeightUndoableCommand::Ptr	heightCmd (float h)=0
virtual void	height (float h)
virtual float	height () const =0
Public Member Functions inherited from Ufe::LightInterface
	LightInterface ()
	Constructor. More...
	LightInterface (const LightInterface &)=default
	Default copy constructor. More...
virtual	~LightInterface ()
	Destructor. More...

Detailed Description

Definition at line 41 of file light2.h.

Member Typedef Documentation

HeightUndoableCommand

using Ufe::AreaLightInterface::HeightUndoableCommand = SetFloatUndoableCommand

Definition at line 54 of file light2.h.

NormalizeUndoableCommand

using Ufe::AreaLightInterface::NormalizeUndoableCommand = SetBoolUndoableCommand

Definition at line 52 of file light2.h.

Ptr

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

Definition at line 44 of file light2.h.

WidthUndoableCommand

using Ufe::AreaLightInterface::WidthUndoableCommand = SetFloatUndoableCommand

Definition at line 53 of file light2.h.

Constructor & Destructor Documentation

AreaLightInterface() [1/2]

Ufe::AreaLightInterface::AreaLightInterface

(

)

Constructor.

AreaLightInterface() [2/2]

Ufe::AreaLightInterface::AreaLightInterface ( const AreaLightInterface &  )

default

Default copy constructor.

~AreaLightInterface()

virtual Ufe::AreaLightInterface::~AreaLightInterface ( )

overridevirtual

Destructor.

Member Function Documentation

height() [1/2]

virtual float Ufe::AreaLightInterface::height ( ) const

pure virtual

Retrieve the height for the light

Returns

the height value

height() [2/2]

virtual void Ufe::AreaLightInterface::height ( float  h )

inlinevirtual

Set the height . Default implementation uses HeightUndoableCommand.

Parameters

h	the new height value.

Definition at line 99 of file light2.h.

heightCmd()

virtual HeightUndoableCommand::Ptr Ufe::AreaLightInterface::heightCmd ( float  h )

pure virtual

Create an undoable command to set the height. The command is not executed.

Parameters

h	the new height value.

Returns

Undoable command to set the height

normalize() [1/2]

virtual bool Ufe::AreaLightInterface::normalize ( ) const

pure virtual

Retrieve the normalize flag for the light

Returns

the normalize flag value

normalize() [2/2]

virtual void Ufe::AreaLightInterface::normalize ( bool  nl )

inlinevirtual

Normalize attribute. Normalizes power by the surface area of the light. Set the normalize flag. Default implementation uses NormalizeUndoableCommand.

Parameters

nl	the new normalize flag value.

Definition at line 65 of file light2.h.

normalizeCmd()

virtual NormalizeUndoableCommand::Ptr Ufe::AreaLightInterface::normalizeCmd ( bool  nl )

pure virtual

Normalize attribute. Normalizes power by the surface area of the light. Create an undoable command to set the normalize flag. The command is not executed.

Parameters

nl	the new normalize flag value.

Returns

Undoable command to set the normalize flag

width() [1/2]

virtual float Ufe::AreaLightInterface::width ( ) const

pure virtual

Retrieve the width for the light

Returns

the width value

width() [2/2]

virtual void Ufe::AreaLightInterface::width ( float  w )

inlinevirtual

Set the width . Default implementation uses WidthUndoableCommand.

Parameters

w	the new width value.

Definition at line 82 of file light2.h.

widthCmd()

virtual WidthUndoableCommand::Ptr Ufe::AreaLightInterface::widthCmd ( float  w )

pure virtual

Create an undoable command to set the width. The command is not executed.

Parameters

w	the new width value.

Returns

Undoable command to set the width

---

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

• common/include/ufe/light2.h