XII Release 0.1.0
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
xiiVisualizerAdapter Class Referenceabstract

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

#include <VisualizerAdapter.h>

Inheritance diagram for xiiVisualizerAdapter:
[legend]

Public Member Functions

void SetVisualizer (const xiiVisualizerAttribute *pAttribute, const xiiDocumentObject *pObject)
 

Protected Member Functions

virtual xiiTransform GetObjectTransform () const
 
xiiObjectAccessorBase * GetObjectAccessor () const
 
const xiiAbstractProperty * 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 xiiVisualizerAttribute * m_pVisualizerAttr
 
const xiiDocumentObject * m_pObject
 

Detailed Description

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

Typically visualizers are configured with xiiVisualizerAttribute'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 xiiEngineGizmoHandle 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 xiiVisualizerAdapter::Finalize ( )
protectedpure virtual

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

Implemented in xiiBoxReflectionProbeVisualizerAdapter, xiiBoxVisualizerAdapter, xiiCameraVisualizerAdapter, xiiCapsuleVisualizerAdapter, xiiConeVisualizerAdapter, xiiCylinderVisualizerAdapter, xiiDirectionVisualizerAdapter, xiiPointLightVisualizerAdapter, xiiSphereVisualizerAdapter, and xiiSpotLightVisualizerAdapter.

◆ Update()

virtual void xiiVisualizerAdapter::Update ( )
protectedpure virtual

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

Implemented in xiiBoxReflectionProbeVisualizerAdapter, xiiBoxVisualizerAdapter, xiiCameraVisualizerAdapter, xiiCapsuleVisualizerAdapter, xiiConeVisualizerAdapter, xiiCylinderVisualizerAdapter, xiiDirectionVisualizerAdapter, xiiPointLightVisualizerAdapter, xiiSphereVisualizerAdapter, and xiiSpotLightVisualizerAdapter.

◆ UpdateGizmoTransform()

virtual void xiiVisualizerAdapter::UpdateGizmoTransform ( )
protectedpure virtual

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

Implemented in xiiBoxReflectionProbeVisualizerAdapter, xiiBoxVisualizerAdapter, xiiCameraVisualizerAdapter, xiiCapsuleVisualizerAdapter, xiiConeVisualizerAdapter, xiiCylinderVisualizerAdapter, xiiDirectionVisualizerAdapter, xiiPointLightVisualizerAdapter, xiiSphereVisualizerAdapter, and xiiSpotLightVisualizerAdapter.

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