Cafu Engine
EditorMaterialI Class Referenceabstract
Inheritance diagram for EditorMaterialI:

Public Member Functions

virtual int GetWidth () const =0
 
virtual int GetHeight () const =0
 
virtual const wxString & GetName () const =0
 
virtual void Draw (wxDC &dc, const wxRect &DestRect, int NameBoxHeight, bool DrawNameBox) const =0
 
virtual const wxImage & GetImage () const =0
 
virtual MatSys::RenderMaterialTGetRenderMaterial (bool PreviewMode) const =0
 Returns the render material of this material. More...
 
virtual MaterialTGetMaterial () const =0
 Returns the material object. More...
 
virtual bool IsTranslucent () const =0
 Returns whether this material is rendered translucently. More...
 
virtual bool ShowInMaterialBrowser () const =0
 Returns whether the material should be shown for selection in the materials browser. More...
 

Member Function Documentation

virtual MaterialT* EditorMaterialI::GetMaterial ( ) const
pure virtual

Returns the material object.

Implemented in DummyMaterialT, and EngineMaterialT.

virtual MatSys::RenderMaterialT* EditorMaterialI::GetRenderMaterial ( bool  PreviewMode) const
pure virtual

Returns the render material of this material.

Parameters
PreviewModeIf true, the render material for 3D preview mode is returned (as it would appear in Cafu). If false, the render material for the 3D edit mode is returned (derived from the meta_editorImage, better for editing in CaWE).

Implemented in DummyMaterialT, and EngineMaterialT.

virtual bool EditorMaterialI::IsTranslucent ( ) const
pure virtual

Returns whether this material is rendered translucently.

Translucent materials are typically implemented with "alpha blending" and require rendering in back-to-front order. Classes that derive from MapElementT typically use this to determine the return value for their MapElementT::IsTranslucent() method.

See Also
MapElementT::IsTranslucent()

Implemented in DummyMaterialT, and EngineMaterialT.

virtual bool EditorMaterialI::ShowInMaterialBrowser ( ) const
pure virtual

Returns whether the material should be shown for selection in the materials browser.

Useful for letting sprite and model materials out.

Implemented in DummyMaterialT, and EngineMaterialT.


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