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::Material Class Referenceabstract

Abstract base class for Material interface. More...

#include <material.h>

Public Types

typedef std::shared_ptr< MaterialPtr
 

Public Member Functions

 Material ()
 Constructor. More...
 
 Material (const Material &)=default
 Default copy constructor. More...
 
virtual ~Material ()
 Destructor. More...
 
virtual std::vector< SceneItem::PtrgetMaterials () const =0
 Returns all the materials assigned to this scene item. More...
 

Static Public Member Functions

static Ptr material (const SceneItem::Ptr &item)
 

Detailed Description

Abstract base class for Material interface.

This base class defines the interface that runtimes can implement to provide basic material behavior, e.g. querying the materials assigned to a SceneItem.

To avoid the memory-consuming "one proxy object per scene object" approach, Material interface objects should be obtained and used within a local scope, and not stored. Material interfaces should be considered stateless, and can be bound to new selection items.

Definition at line 31 of file material.h.

Member Typedef Documentation

◆ Ptr

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

Definition at line 34 of file material.h.

Constructor & Destructor Documentation

◆ Material() [1/2]

Ufe::Material::Material ( )

Constructor.

◆ Material() [2/2]

Ufe::Material::Material ( const Material )
default

Default copy constructor.

◆ ~Material()

virtual Ufe::Material::~Material ( )
virtual

Destructor.

Member Function Documentation

◆ getMaterials()

virtual std::vector<SceneItem::Ptr> Ufe::Material::getMaterials ( ) const
pure virtual

Returns all the materials assigned to this scene item.

◆ material()

static Ptr Ufe::Material::material ( const SceneItem::Ptr item)
static

Convenience method that calls the material method on the Material handler for the item. Returns a null pointer if the argument is null, or has an empty path.

Parameters
itemSceneItem for which Material interface is desired.
Returns
Material interface of the given SceneItem.

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