Ufe::Transform3dRead Class Reference

Read-only abstract base class for 3D transform interface. More...

#include <transform3d.h>

Inheritance diagram for Ufe::Transform3dRead:

Public Types
typedef std::shared_ptr< Transform3dRead >	Ptr

Public Member Functions
	Transform3dRead ()
	Constructor. More...
	Transform3dRead (const Transform3dRead &)=default
	Default copy constructor. More...
virtual	~Transform3dRead ()
	Destructor. More...
virtual const Path &	path () const =0
virtual SceneItem::Ptr	sceneItem () const =0
virtual Matrix4d	matrix () const =0
Matrix4d	inclusiveMatrix () const
Matrix4d	exclusiveMatrix () const
virtual Matrix4d	segmentInclusiveMatrix () const =0
virtual Matrix4d	segmentExclusiveMatrix () const =0

Static Public Member Functions
static Ptr	transform3dRead (const SceneItem::Ptr &item)

Detailed Description

Read-only abstract base class for 3D transform interface.

Definition at line 52 of file transform3d.h.

Member Typedef Documentation

Ptr

typedef std::shared_ptr<Transform3dRead> Ufe::Transform3dRead::Ptr

Definition at line 55 of file transform3d.h.

Constructor & Destructor Documentation

Transform3dRead() [1/2]

Ufe::Transform3dRead::Transform3dRead

(

)

Constructor.

Transform3dRead() [2/2]

Ufe::Transform3dRead::Transform3dRead ( const Transform3dRead &  )

default

Default copy constructor.

~Transform3dRead()

virtual Ufe::Transform3dRead::~Transform3dRead ( )

virtual

Destructor.

Member Function Documentation

exclusiveMatrix()

Matrix4d Ufe::Transform3dRead::exclusiveMatrix

(

)

const

Retrieve the exclusive Matrix of the object. This matrix includes the transformation's inclusive matrix of this object's parent, without the object itself.

Returns

Exclusive Matrix4d of the SceneItem.

inclusiveMatrix()

Matrix4d Ufe::Transform3dRead::inclusiveMatrix

(

)

const

Retrieve the inclusive Matrix of the object. This matrix includes the transformation's inclusive matrix of this object's parent, and the object itself.

Returns

Inclusive Matrix4d of the SceneItem.

matrix()

virtual Matrix4d Ufe::Transform3dRead::matrix ( ) const

pure virtual

Retrieve the object's local transform matrix.

Returns

The object's transform matrix.

path()

virtual const Path& Ufe::Transform3dRead::path ( ) const

pure virtual

Returns

the object's Path.

sceneItem()

virtual SceneItem::Ptr Ufe::Transform3dRead::sceneItem ( ) const

pure virtual

Returns

the object's SceneItem.

segmentExclusiveMatrix()

virtual Matrix4d Ufe::Transform3dRead::segmentExclusiveMatrix ( ) const

pure virtual

Retrieve the exclusive Matrix of the object, for all objects in the tail segment of the object's path, excluding the object itself. The tail segment exclusive matrix and inclusive matrices of other segments of a path are multiplied together by exclusiveMatrix(), from head to tail, to obtain the full transformation. In the case of a trivial single segment path, the segmentExclusiveMatrix and the exclusiveMatrix are the same.

Returns

The PathSegment's exclusive transform matrix

segmentInclusiveMatrix()

virtual Matrix4d Ufe::Transform3dRead::segmentInclusiveMatrix ( ) const

pure virtual

Retrieve the inclusive Matrix of the object, for all objects in the tail segment of the object's path, including the object itself. The segment inclusive matrices of a path are multiplied together by inclusiveMatrix(), from head to tail, to obtain the full transformation. In the case of a trivial single segment path, the segmentInclusiveMatrix and the inclusiveMatrix are the same.

Returns

The PathSegment's transform matrix

transform3dRead()

static Ptr Ufe::Transform3dRead::transform3dRead ( const SceneItem::Ptr &  item )

static

Convenience method that calls the Ufe::Transform3dHandler::transform3dRead() method on the Transform3d handler for the item. Returns a null pointer if the argument is null, or has an empty path.

Parameters

item	SceneItem on which to create Transform3dRead interface.

Returns

Transform3dRead for the given SceneItem

---

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

• common/include/ufe/transform3d.h