ufe  4.2
Universal Front End is a DCC-agnostic component that will allow a DCC to browse and edit data in multiple data models
Ufe::Transform3dHandler Class Referenceabstract

Factory base class for Transform3d interface. More...

#include <transform3dHandler.h>

Public Types

typedef std::shared_ptr< Transform3dHandlerPtr
 

Public Member Functions

 Transform3dHandler ()
 Constructor. More...
 
 Transform3dHandler (const Transform3dHandler &)=default
 Default copy constructor. More...
 
virtual ~Transform3dHandler ()
 Destructor. More...
 
virtual Transform3dRead::Ptr transform3dRead (const SceneItem::Ptr &item) const
 
virtual Transform3d::Ptr transform3d (const SceneItem::Ptr &item) const =0
 
virtual Transform3d::Ptr editTransform3d (const SceneItem::Ptr &item, const EditTransform3dHint &hint=EditTransform3dHint()) const
 

Detailed Description

Factory base class for Transform3d interface.

This base class defines an interface for factory objects that runtimes can implement to create a Transform3d interface object.

Definition at line 26 of file transform3dHandler.h.

Member Typedef Documentation

◆ Ptr

Definition at line 29 of file transform3dHandler.h.

Constructor & Destructor Documentation

◆ Transform3dHandler() [1/2]

Ufe::Transform3dHandler::Transform3dHandler ( )

Constructor.

◆ Transform3dHandler() [2/2]

Ufe::Transform3dHandler::Transform3dHandler ( const Transform3dHandler )
default

Default copy constructor.

◆ ~Transform3dHandler()

virtual Ufe::Transform3dHandler::~Transform3dHandler ( )
virtual

Destructor.

Member Function Documentation

◆ editTransform3d()

virtual Transform3d::Ptr Ufe::Transform3dHandler::editTransform3d ( const SceneItem::Ptr item,
const EditTransform3dHint hint = EditTransform3dHint() 
) const
inlinevirtual

Return an interface to be used to edit the 3D transformation of the object. By default, returns the normal Transform3d interface. The edit transform object may have a different local transformation and a different Ufe::Transform3d::segmentInclusiveMatrix() and Ufe::Transform3d::segmentExclusiveMatrix() than the normal Transform3d interface associated with a scene item. All changes made through the edit transform 3D object will be visible through the normal Ufe::Transform3d::transform3d() interface.

Parameters
itemSceneItem to use to retrieve its Transform3d interface.
hintContextual information for Transform3d interface creation.
Returns
Transform3d interface of given SceneItem. Returns a null pointer if no Transform3d interface can be created for the item.

Definition at line 69 of file transform3dHandler.h.

◆ transform3d()

virtual Transform3d::Ptr Ufe::Transform3dHandler::transform3d ( const SceneItem::Ptr item) const
pure virtual

Creates a Transform3d interface on the given SceneItem.

Parameters
itemSceneItem to use to retrieve its Transform3d interface.
Returns
Transform3d interface of given SceneItem. Returns a null pointer if no Transform3d interface can be created for the item.

◆ transform3dRead()

virtual Transform3dRead::Ptr Ufe::Transform3dHandler::transform3dRead ( const SceneItem::Ptr item) const
virtual

Creates a Transform3dRead interface on the given SceneItem. By default, calls transform3d().

Parameters
itemSceneItem to use to retrieve its Transform3dRead interface.
Returns
Transform3dRead interface of given SceneItem. Returns a null pointer if no Transform3dRead interface can be created for the item.

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