BRAY::LightInstancerPtr Class Reference

#include <BRAY_Interface.h>

Inheritance diagram for BRAY::LightInstancerPtr:

Public Member Functions
	LightInstancerPtr (UT_SharedPtr< LightInstancer > p=nullptr)
	~LightInstancerPtr () override
bool	isValid () const
SYS_SAFE_BOOL	operator bool () const
	Convenient validity testing. More...
const UT_StringHolder &	name () const
	Return the name of the instancer. More...
void	setInstanceTransforms (ScenePtr &scene, const UT_Array< SpacePtr > &xforms)
	Set the instance transforms. More...
void	setInstanceProperties (ScenePtr &scene, const GT_AttributeListHandle &alist)
	Set the instance properties. More...
void	addPrototype (ScenePtr &scene, const LightPtr &light)
void	addPrototype (ScenePtr &scene, const LightInstancerPtr &inst)
void	commit (ScenePtr &scene)
	Commit the current prototypes to the scene. More...
void	clear (ScenePtr &scene)
	Clear all instances from the Scene. More...
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< LightInstancer >	myInstancer

Friends
class	LightInstancer

Detailed Description

Definition at line 991 of file BRAY_Interface.h.

Constructor & Destructor Documentation

BRAY::LightInstancerPtr::LightInstancerPtr ( UT_SharedPtr< LightInstancer >  p = nullptr )

inline

Definition at line 994 of file BRAY_Interface.h.

BRAY::LightInstancerPtr::~LightInstancerPtr ( )

override

Member Function Documentation

void BRAY::LightInstancerPtr::addPrototype	(	ScenePtr &	scene,
		const LightPtr &	light
	)

Add a light prototype for instancing If a light prototype with the same name exists, the new prototype is not added, but the instances belonging to that name are updated on the next commit

void BRAY::LightInstancerPtr::addPrototype	(	ScenePtr &	scene,
		const LightInstancerPtr &	inst
	)

Add a light instancer prototype for instancing If a light prototype with the same name exists, the new prototype is not added, but the instances belonging to that name are updated on the next commit

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

inlinestatic

Test if Instancable is of this type.

Definition at line 1002 of file BRAY_Interface.h.

void BRAY::LightInstancerPtr::clear

(

ScenePtr &

scene

)

Clear all instances from the Scene.

void BRAY::LightInstancerPtr::commit

(

ScenePtr &

scene

)

Commit the current prototypes to the scene.

bool BRAY::LightInstancerPtr::isValid ( ) const

inline

Definition at line 1008 of file BRAY_Interface.h.

const UT_StringHolder& BRAY::LightInstancerPtr::name

(

)

const

Return the name of the instancer.

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

inline

Convenient validity testing.

Definition at line 1011 of file BRAY_Interface.h.

void BRAY::LightInstancerPtr::setInstanceProperties	(	ScenePtr &	scene,
		const GT_AttributeListHandle &	alist
	)

Set the instance properties.

void BRAY::LightInstancerPtr::setInstanceTransforms	(	ScenePtr &	scene,
		const UT_Array< SpacePtr > &	xforms
	)

Set the instance transforms.

Friends And Related Function Documentation

friend class LightInstancer

friend

Definition at line 1047 of file BRAY_Interface.h.

Member Data Documentation

UT_SharedPtr<LightInstancer> BRAY::LightInstancerPtr::myInstancer

protected

Definition at line 1045 of file BRAY_Interface.h.

---

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

• BRAY/BRAY_Interface.h