class MDrawProcedureBase

Jump to documentation

public members:

	MDrawProcedureBase (const MString & name )
virtual	~MDrawProcedureBase ()
virtual bool	execute ()
void	setEnabled (bool value)
bool	enabled () const
void	setName ( const MString & name )
const MString &	name () const

Documentation

Description

This class provides an interface through which a plug-in can be writen to implement a class to provide custom hardware drawing effects.

The derived class can be added, removed, or reordered in a list of draw procedures used by the hardware renderer. Please refer to documentation for MhardwareRenderer for more details.

Each procedure has a user defined string name and can be enabled or disabled. Name, and enabling methods must be defined.

All derived classes must over the execute() method. This is the method that will be called by the hardware renderer to which the procedure is attached. The call will only be made if the procedure is enabled.

Functions

MDrawProcedureBase:: MDrawProcedureBase (const MString & name )

Description

Constructor for a draw procedure. By default the procedure is disabled.

Arguments

• name : name of the procedure. This is a required argument.

Return Value

• None.

MDrawProcedureBase:: ~MDrawProcedureBase ()

Description

Default destructor for a draw procedure.

Arguments

• None.

Return Value

• None.

bool MDrawProcedureBase:: execute ()

Description

This method gets called by the renderer to execture the draw procedure. Derived class of MDrawProcedureBase must implement this method as it defined as a pure virtual method on this class. The implementation is free to perform any drawing functionality from within this method.

Return Value

• true : if execution was successful.

void MDrawProcedureBase:: setEnabled (bool value)

Description

This method sets whether the draw procedure is enabled or not.

Arguments

• value : Boolean value to set the enabling state.

Return Value

• None.

bool MDrawProcedureBase:: enabled () const

Description

This method returns whether the draw procedure is enabled or not.

Arguments

• None.

Return Value

• boolean indicating enable state.

void MDrawProcedureBase:: setName ( const MString & name )

Description

This method sets the name for the draw procedure.

Arguments

• name : Name to set.

Return Value

• None.

const MString & MDrawProcedureBase:: name () const

Description

This method returns the name of the draw procedure.

Arguments

• None.

Return Value

• String name.

This class has no child classes.