ezSplineManipulatorAdapter Class Reference

Makes spline nodes editable in the editor by providing small helper gizmos to easily add new nodes. More...

#include <SplineManipulatorAdapter.h>

Inheritance diagram for ezSplineManipulatorAdapter:

Static Public Member Functions
static ezResult	BuildSpline (const ezDocumentObject *pSplineComponent, ezStringView sClosedPropertyName, ezSpline &out_spline, ezStringView sNodeName=ezStringView(), ezUInt32 *out_pNodeIndex=nullptr)
static ezResult	FillControlPointFromNodeComponent (const ezDocumentObject *pNodeComponent, ezSpline::ControlPoint &out_cp)

Protected Member Functions
virtual void	Finalize () override
	Called once after SetManipulator(). Use this for one-time gizmo setup that depends on m_pObject being valid.
virtual void	Update () override
	Called when a relevant property on m_pObject changes, after a transaction finishes, or on visibility changes.
void	ClickGizmoEventHandler (const ezGizmoEvent &e)
virtual void	UpdateGizmoTransform () override
	Called every frame before the viewport redraws. Update gizmo world-space transforms here.
void	BuildSpline ()
void	ConfigureGizmos ()
void	MakeUniqueName (ezInt32 iIndex, ezStringBuilder &ref_sName)
Protected Member Functions inherited from ezManipulatorAdapter
virtual ezTransform	GetOffsetTransform () const
virtual ezTransform	GetObjectTransform () const
ezObjectAccessorBase *	GetObjectAccessor () const
const ezAbstractProperty *	GetProperty (const char *szProperty) const
void	BeginTemporaryInteraction ()
	Starts a temporary command sequence for live drag interaction. Must be paired with EndTemporaryInteraction() or CancelTemporayInteraction().
void	EndTemporaryInteraction ()
void	CancelTemporayInteraction ()
void	ChangeProperties (const char *szProperty1, ezVariant value1, const char *szProperty2=nullptr, ezVariant value2=ezVariant(), const char *szProperty3=nullptr, ezVariant value3=ezVariant(), const char *szProperty4=nullptr, ezVariant value4=ezVariant(), const char *szProperty5=nullptr, ezVariant value5=ezVariant(), const char *szProperty6=nullptr, ezVariant value6=ezVariant())
	Convenience wrapper that starts a transaction, sets up to six properties on m_pObject, and finishes the transaction.
void	ClampProperty (const char *szProperty, ezVariant &value) const

Protected Attributes
ezSpline	m_Spline
ezDeque< ezClickGizmo >	m_Gizmos
Protected Attributes inherited from ezManipulatorAdapter
bool	m_bManipulatorIsVisible = false
const ezManipulatorAttribute *	m_pManipulatorAttr = nullptr
const ezDocumentObject *	m_pObject = nullptr
	The document object this adapter operates on. Valid for the lifetime of the adapter.

Additional Inherited Members
Public Member Functions inherited from ezManipulatorAdapter
void	SetManipulator (const ezManipulatorAttribute *pAttribute, const ezDocumentObject *pObject)
	Connects this adapter to the given attribute and document object, then calls Finalize() and Update().
virtual void	QueryGridSettings (ezGridSettingsMsgToEngine &out_gridSettings)

Detailed Description

Makes spline nodes editable in the editor by providing small helper gizmos to easily add new nodes.

Enabled by attaching the ezSplineManipulatorAttribute.

Member Function Documentation

Finalize()

void ezSplineManipulatorAdapter::Finalize ( )

overrideprotectedvirtual

Called once after SetManipulator(). Use this for one-time gizmo setup that depends on m_pObject being valid.

Implements ezManipulatorAdapter.

Update()

void ezSplineManipulatorAdapter::Update ( )

overrideprotectedvirtual

Called when a relevant property on m_pObject changes, after a transaction finishes, or on visibility changes.

Implements ezManipulatorAdapter.

UpdateGizmoTransform()

void ezSplineManipulatorAdapter::UpdateGizmoTransform ( )

overrideprotectedvirtual

Called every frame before the viewport redraws. Update gizmo world-space transforms here.

Implements ezManipulatorAdapter.

---

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

• /home/runner/work/ezEngine/ezEngine/Code/Editor/EditorFramework/Manipulators/SplineManipulatorAdapter.h
• /home/runner/work/ezEngine/ezEngine/Code/Editor/EditorFramework/Manipulators/Implementation/SplineManipulatorAdapter.cpp