plVisualizerAdapter Class Reference

Base class for the editor side code that sets up a 'visualizer' for object properties. More...

#include <VisualizerAdapter.h>

Inheritance diagram for plVisualizerAdapter:

Public Member Functions
void	SetVisualizer (const plVisualizerAttribute *pAttribute, const plDocumentObject *pObject)

Protected Member Functions
virtual plTransform	GetObjectTransform () const
plObjectAccessorBase *	GetObjectAccessor () const
const plAbstractProperty *	GetProperty (const char *szProperty) const
virtual void	Finalize ()=0
	Called to actually properly set up the adapter. All setup code is implemented here.
virtual void	Update ()=0
	Called when object properties have changed and the visualizer may need to react.
virtual void	UpdateGizmoTransform ()=0
	Called when the object has been moved somehow. More light weight than a full update.

Protected Attributes
bool	m_bVisualizerIsVisible
const plVisualizerAttribute *	m_pVisualizerAttr
const plDocumentObject *	m_pObject

Detailed Description

Base class for the editor side code that sets up a 'visualizer' for object properties.

Typically visualizers are configured with plVisualizerAttribute's on component types. The adapter reads the attribute values and sets up the necessary code to render them in the engine. This is usually achieved by creating plEngineGizmoHandle objects (which get automatically synchronized with the engine process). The adapter then reacts to editor side object changes and adjusts the engine side representation as needed.

Member Function Documentation

Finalize()

virtual void plVisualizerAdapter::Finalize ( )

protectedpure virtual

Called to actually properly set up the adapter. All setup code is implemented here.

Implemented in plBoxReflectionProbeVisualizerAdapter, plBoxVisualizerAdapter, plCameraVisualizerAdapter, plCapsuleVisualizerAdapter, plConeVisualizerAdapter, plCylinderVisualizerAdapter, plDirectionVisualizerAdapter, plPointLightVisualizerAdapter, plSphereVisualizerAdapter, and plSpotLightVisualizerAdapter.

Update()

virtual void plVisualizerAdapter::Update ( )

protectedpure virtual

Called when object properties have changed and the visualizer may need to react.

Implemented in plBoxReflectionProbeVisualizerAdapter, plBoxVisualizerAdapter, plCameraVisualizerAdapter, plCapsuleVisualizerAdapter, plConeVisualizerAdapter, plCylinderVisualizerAdapter, plDirectionVisualizerAdapter, plPointLightVisualizerAdapter, plSphereVisualizerAdapter, and plSpotLightVisualizerAdapter.

UpdateGizmoTransform()

virtual void plVisualizerAdapter::UpdateGizmoTransform ( )

protectedpure virtual

Called when the object has been moved somehow. More light weight than a full update.

Implemented in plBoxReflectionProbeVisualizerAdapter, plBoxVisualizerAdapter, plCameraVisualizerAdapter, plCapsuleVisualizerAdapter, plConeVisualizerAdapter, plCylinderVisualizerAdapter, plDirectionVisualizerAdapter, plPointLightVisualizerAdapter, plSphereVisualizerAdapter, and plSpotLightVisualizerAdapter.

---

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

• Code/Editor/EditorFramework/Visualizers/VisualizerAdapter.h
• Code/Editor/EditorFramework/Visualizers/Implementation/VisualizerAdapter.cpp