BRAY::LightPtr Class Reference

#include <BRAY_Interface.h>

Public Member Functions
	LightPtr (const UT_SharedPtr< BRAY_Light > &lp=UT_SharedPtr< BRAY_Light >())
	~LightPtr ()
bool	isValid () const
	Test validity. More...
BRAY_LightType	type () const
	Return the type of light. More...
void	setTransform (const SpacePtr &xforms)
	Set the transform on the instance. 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...
OptionSet	lightProperties ()
	Get the current light properties for modification. 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 ()

Protected Attributes
UT_SharedPtr< BRAY_Light >	myLight

Detailed Description

Definition at line 740 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 743 of file BRAY_Interface.h.

BRAY::LightPtr::~LightPtr

(

)

Member Function Documentation

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 750 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 755 of file BRAY_Interface.h.

BRAY_Light* BRAY::LightPtr::lightPtr ( )

inline

Access to the underlying object

Definition at line 756 of file BRAY_Interface.h.

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 754 of file BRAY_Interface.h.

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 on the instance.

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.

Member Data Documentation

UT_SharedPtr<BRAY_Light> BRAY::LightPtr::myLight

protected

Definition at line 793 of file BRAY_Interface.h.

---

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

• BRAY/BRAY_Interface.h