BevelProfileCurveUser Class Reference

A plugin which wants to use the Bevel Profile Curves should derive from this class and implement the following methods. More...

#include <BevelProfileInterface.h>

Public Member Functions
virtual void	ChangedBevelProfile ()=0
	Lets the curve user know that the bevel profile has changed in some way.
virtual void	InhibitMesh (bool sw)=0
	Tells the plugin to update or not update its mesh on changes to the profile.
virtual void	RedrawBevelProfile ()=0
	When this is called, if the plugin is using the Bevel Profile Editor, it should call bevelProfileEditorInfo->Notify(WM_BEVELPROFILE_REDRAW, 0, 0) to force a redraw.
virtual bool	GetAutoBevelUpdate ()=0
	When this is called, the plugin should return its auto bevel update switch state.
virtual void	SetAutoBevelUpdate (bool sw)=0
	When this is called, the plugin should store the switch state for use when GetAutoBevelUpdate is called.
virtual HWND	GetBevelProfileEditorHWND ()=0
	Get the bevel profile editor window handle.
virtual void	SetBevelProfileCurveInterface (BevelProfileCurveInterface *curve)=0
	The system will call this method to set the plugin's bevel profile curve.
virtual BevelProfileCurveInterface *	GetBevelProfileCurveInterface ()=0
	When this is called, the plugin should return its bevel profile curve interface.
virtual void	BevelPresetSelectionChanged ()=0
	This is called when the bevel peset selection has changed.
virtual BevelProfileEditorInformation *	GetBevelProfileEditorInformation ()=0
	When called, the plugin should return its BevelProfileEditorInformation pointer.
virtual HWND	BevelProfileEditorOwningWindow ()=0
	When called, the plugin should return the handle of the window that owns the Bevel Profile Editor.

Detailed Description

A plugin which wants to use the Bevel Profile Curves should derive from this class and implement the following methods.

Member Function Documentation

ChangedBevelProfile()

virtual void ChangedBevelProfile ( )

pure virtual

Lets the curve user know that the bevel profile has changed in some way.

This can be via the user selecting a different profile or other editing methods if the Bevel Profile Editor is in use. The plugin should update its model if it has not been inhibited via the InhibitMesh call (see below)

InhibitMesh()

virtual void InhibitMesh ( bool  sw )

pure virtual

Tells the plugin to update or not update its mesh on changes to the profile.

The plugin should maintain an internal switch to keep track of this setting.

Parameters

sw	- If true, the plugin should ignore changes to the bevel profile curve untin this method is called again with 'sw' set to false.

RedrawBevelProfile()

virtual void RedrawBevelProfile ( )

pure virtual

When this is called, if the plugin is using the Bevel Profile Editor, it should call bevelProfileEditorInfo->Notify(WM_BEVELPROFILE_REDRAW, 0, 0) to force a redraw.

GetAutoBevelUpdate()

virtual bool GetAutoBevelUpdate ( )

pure virtual

When this is called, the plugin should return its auto bevel update switch state.

This lets the editor call beck to tell the plugin to update itrs mesh when changes to the curve are made.

Returns

true if the mesh should auto-update on changes to the bevel profile curve

SetAutoBevelUpdate()

virtual void SetAutoBevelUpdate ( bool  sw )

pure virtual

When this is called, the plugin should store the switch state for use when GetAutoBevelUpdate is called.

Parameters

sw	- The automatic update flag.

GetBevelProfileEditorHWND()

virtual HWND GetBevelProfileEditorHWND ( )

pure virtual

Get the bevel profile editor window handle.

Returns

Plugins should return bevelProfileEditorInfo->GetHWND() (see above)

SetBevelProfileCurveInterface()

virtual void SetBevelProfileCurveInterface ( BevelProfileCurveInterface *  curve )

pure virtual

The system will call this method to set the plugin's bevel profile curve.

Parameters

curve

- The bevel profile curve to set. This should be stored as a reference in your plugin

GetBevelProfileCurveInterface()

virtual BevelProfileCurveInterface * GetBevelProfileCurveInterface ( )

pure virtual

When this is called, the plugin should return its bevel profile curve interface.

Returns

The BevelProfileCurveInterface in use by the plugin

BevelPresetSelectionChanged()

virtual void BevelPresetSelectionChanged ( )

pure virtual

This is called when the bevel peset selection has changed.

When this call is received, the plugin should update its current bevel preset selection in the UI by calling BevelProfileInterface::LoadBevelProfilePresetList(presetList, true);

GetBevelProfileEditorInformation()

virtual BevelProfileEditorInformation * GetBevelProfileEditorInformation ( )

pure virtual

When called, the plugin should return its BevelProfileEditorInformation pointer.

Returns

The plugin's BevelProfileEditorInformation pointer

BevelProfileEditorOwningWindow()

virtual HWND BevelProfileEditorOwningWindow ( )

pure virtual

When called, the plugin should return the handle of the window that owns the Bevel Profile Editor.

Returns

The handle of the window which owns the editor. Typically this will be the plugin's main rollup window.