BRAY::LightPtr Class Reference

#include <BRAY_Interface.h>

Inheritance diagram for BRAY::LightPtr:

Public Member Functions
	LightPtr (const UT_SharedPtr< BRAY_Light > &lp=UT_SharedPtr< BRAY_Light >())
	~LightPtr () override
bool	isValid () const
	Test validity. More...
BRAY_LightType	type () const
	Return the type of light. More...
const UT_StringHolder &	name () const
	Return the name of the light. More...
SpacePtr	transform () const
	Return the transform of the light. More...
void	setTransform (const SpacePtr &xforms)
	Set the transform of the light. More...
void	setShader (const ScenePtr &scene, const UT_StringArray &args)
	Set the shader for the light. More...
OptionSet	objectProperties ()
	Get the current object properties for modification. More...
void	setObjectProperties (const OptionSet &oprops)
	Set the object properties. More...
OptionSet	lightProperties ()
	Get the current light properties for modification. More...
void	setLightProperties (const OptionSet &lprops)
	Set the light properties. More...
void	commitOptions (ScenePtr &scene)
	After changing any options, must lock prior to rendering. More...
void	updateShaderGraph (const ScenePtr &scene, const ShaderGraphPtr &graphptr, const UT_Array< ShaderGraphPtr > &light_filters)
	Update the light shader graph. More...
void	updateFilters (const ScenePtr &scene, const UT_Array< ShaderGraphPtr > &filters)
void	eraseFilter (const ScenePtr &scene, const UT_StringRef &shader_graph_name)
	Notify the light that a filter has been deleted. More...
SYS_SAFE_BOOL	operator bool () const
const BRAY_Light *	lightPtr () const
BRAY_Light *	lightPtr ()
Public Member Functions inherited from BRAY::InstancablePtr
	InstancablePtr (InstancableType type)
virtual	~InstancablePtr ()=0
InstancableType	instancableType () const

Static Public Member Functions
static SYS_FORCE_INLINE bool	classof (const InstancablePtr *o)
	Test if Instancable is of this type. More...

Protected Attributes
UT_SharedPtr< BRAY_Light >	myLight

Friends
class	LightInstancer

Detailed Description

Definition at line 870 of file BRAY_Interface.h.

Constructor & Destructor Documentation

BRAY::LightPtr::LightPtr ( const UT_SharedPtr< BRAY_Light > &  lp = UT_SharedPtr<BRAY_Light>() )

inline

Definition at line 873 of file BRAY_Interface.h.

BRAY::LightPtr::~LightPtr ( )

override

Member Function Documentation

static SYS_FORCE_INLINE bool BRAY::LightPtr::classof ( const InstancablePtr *  o )

inlinestatic

Test if Instancable is of this type.

Definition at line 881 of file BRAY_Interface.h.

void BRAY::LightPtr::commitOptions

(

ScenePtr &

scene

)

After changing any options, must lock prior to rendering.

void BRAY::LightPtr::eraseFilter	(	const ScenePtr &	scene,
		const UT_StringRef &	shader_graph_name
	)

Notify the light that a filter has been deleted.

bool BRAY::LightPtr::isValid ( ) const

inline

Test validity.

Definition at line 887 of file BRAY_Interface.h.

OptionSet BRAY::LightPtr::lightProperties

(

)

Get the current light properties for modification.

const BRAY_Light* BRAY::LightPtr::lightPtr ( ) const

inline

Access to the underlying object

Definition at line 892 of file BRAY_Interface.h.

BRAY_Light* BRAY::LightPtr::lightPtr ( )

inline

Access to the underlying object

Definition at line 893 of file BRAY_Interface.h.

const UT_StringHolder& BRAY::LightPtr::name

(

)

const

Return the name of the light.

OptionSet BRAY::LightPtr::objectProperties

(

)

Get the current object properties for modification.

SYS_SAFE_BOOL BRAY::LightPtr::operator bool ( ) const

inline

Access to the underlying object

Definition at line 891 of file BRAY_Interface.h.

void BRAY::LightPtr::setLightProperties

(

const OptionSet &

lprops

)

Set the light properties.

void BRAY::LightPtr::setObjectProperties

(

const OptionSet &

oprops

)

Set the object properties.

void BRAY::LightPtr::setShader	(	const ScenePtr &	scene,
		const UT_StringArray &	args
	)

Set the shader for the light.

void BRAY::LightPtr::setTransform

(

const SpacePtr &

xforms

)

Set the transform of the light.

SpacePtr BRAY::LightPtr::transform

(

)

const

Return the transform of the light.

BRAY_LightType BRAY::LightPtr::type

(

)

const

Return the type of light.

void BRAY::LightPtr::updateFilters	(	const ScenePtr &	scene,
		const UT_Array< ShaderGraphPtr > &	filters
	)

If a light filter has been modified, this method should be called to notify the light. The set should contain the names of the dirty light filter shader graphs.

void BRAY::LightPtr::updateShaderGraph	(	const ScenePtr &	scene,
		const ShaderGraphPtr &	graphptr,
		const UT_Array< ShaderGraphPtr > &	light_filters
	)

Update the light shader graph.

Friends And Related Function Documentation

friend class LightInstancer

friend

Definition at line 944 of file BRAY_Interface.h.

Member Data Documentation

UT_SharedPtr<BRAY_Light> BRAY::LightPtr::myLight

protected

Definition at line 942 of file BRAY_Interface.h.

---

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

• BRAY/BRAY_Interface.h