ufe  3.2
Universal Front End is a DCC-agnostic component that will allow a DCC to browse and edit data in multiple data models
Ufe::Light::ConeInterface Class Referenceabstract

#include <light.h>

Public Member Functions

virtual ~ConeInterface ()
 
virtual ConePropsUndoableCommand::Ptr conePropsCmd (float focus, float angle, float softness)=0
 
virtual void coneProps (float focus, float angle, float softness)
 
virtual ConeProps coneProps () const =0
 

Detailed Description

Definition at line 372 of file light.h.

Constructor & Destructor Documentation

◆ ~ConeInterface()

virtual Ufe::Light::ConeInterface::~ConeInterface ( )
virtual

Member Function Documentation

◆ coneProps() [1/2]

virtual void Ufe::Light::ConeInterface::coneProps ( float  focus,
float  angle,
float  softness 
)
inlinevirtual

Set the cone properties. Default implementation uses ConePropsUndoableCommand.

Parameters
focusthe rate at which light intensity decreases from the center of the cone.
anglethe cone angle.
softnessdefines the rate at which penumbra kicks in

Definition at line 388 of file light.h.

◆ coneProps() [2/2]

virtual ConeProps Ufe::Light::ConeInterface::coneProps ( ) const
pure virtual

Retrieve the cone properties for the light

Returns
the cone properties

◆ conePropsCmd()

virtual ConePropsUndoableCommand::Ptr Ufe::Light::ConeInterface::conePropsCmd ( float  focus,
float  angle,
float  softness 
)
pure virtual

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

Parameters
focusthe rate at which light intensity decreases from the center of the cone.
anglethe cone angle.
softnessdefines the rate at which penumbra kicks in
Returns
Undoable command to set the cone properties.

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