IFFDMod< T > Class Template Reference

#include <istdplug.h>

Class Description

template<class T>
class IFFDMod< T >

See also

Class Control, Class Point3, Class IPoint3, Class Modifier.

\

Description:

This class is an interface into both FFD OS modifiers and also into helper objects for FFD spacewarps.

Given a pointer to ReferenceTarget ref, you can use it as follows:

Class_ID id = ref->ClassID();
if (id==FFDNMOSSQUARE_CLASS_ID || id==FFDNMOSCYL_CLASS_ID ||
    id==FFD44_CLASS_ID || id==FFD33_CLASS_ID || id==FFD22_CLASS_ID)
    IFFDMod<Modifier>* ffd = (IFFDMod<Modifier>*)ref;
  // call various methods
}
else if(id==FFDNMWSSQUARE_CLASS_ID || id = FFDNMWSCYL_CLASS_ID)
    IFFDMod<WSMObject>* ffd = (IFFDMod<WSMObject>*)ref;
// call various methods
}

Inheritance diagram for IFFDMod< T >:

Public Member Functions
virtual int	NumPts ()=0
virtual int	NumPtConts ()=0
virtual Control *	GetPtCont (int i)=0
virtual void	SetPtCont (int i, Control *c)=0
virtual Point3	GetPt (int i)=0
virtual void	SetPt (int i, Point3 p)=0
virtual void	SetGridDim (IPoint3 d)
virtual IPoint3	GetGridDim ()
virtual void	AnimateAll ()
virtual void	Conform ()
virtual void	SelectPt (int i, BOOL sel, BOOL clearAll=FALSE)
virtual void	PlugControllers (TimeValue t, BOOL all)=0

Member Function Documentation

virtual int NumPts ( )

pure virtual

Remarks

Returns the number of lattice control points.

virtual int NumPtConts ( )

pure virtual

Remarks

Returns the number of Control Ponits having controllers.

virtual Control* GetPtCont ( int  i )

pure virtual

Remarks

Returns a pointer to the 'i-th' Control Point controller.

Parameters:

int i

The zero based index of the Control Point.

virtual void SetPtCont ( int  i, Control *  c  )

pure virtual

Remarks

Sets the controller used by the specified Control Point.

Parameters:

int i

The zero based index of the Control Point.

Control *c

Points to the controller to set.

virtual Point3 GetPt ( int  i )

pure virtual

Remarks

Returns the 'i-th' Control Point.

Parameters:

int i

The zero based index of the Control Point.

virtual void SetPt ( int  i, Point3  p  )

pure virtual

Remarks

Sets the 'i-th' control point.

Parameters:

int i

The zero based index of the Control Point.

Point3 p

The point to set.

virtual void SetGridDim ( IPoint3  d )

inlinevirtual

Remarks

Sets the lattice dimension.

Parameters:

IPoint3 d

The dimensions to set.

Default Implementation:

{ }

{ }             // set the lattice dimensions

virtual IPoint3 GetGridDim ( )

inlinevirtual

Remarks

Returns the lattice dimensions.

Default Implementation:

{ return IPoint3(0,0,0); }

{ return IPoint3(0,0,0); }  // get the lattice dimensions

virtual void AnimateAll ( )

inlinevirtual

Remarks

This method assigns controllers to all the Control Points.

Default Implementation:

{ }

{ }                     // assign controllers to all CP's               

virtual void Conform ( )

inlinevirtual

Remarks

Calling this method is the equivalent of pressing the Conform button in the FFD UI. Note: This method is not valid for WSMObject's.

Default Implementation:

{ }

{ }                         // not valid for WSMObject's

virtual void SelectPt ( int  i, BOOL  sel, BOOL  clearAll = FALSE  )

inlinevirtual

Remarks

Selects or de-selects the specified Control Point.

Parameters:

int i

The zero based index of the Control Point.

BOOL sel

TRUE to select; FALSE to de-selelct.

BOOL clearAll=FALSE

TRUE to clear all the currently selected Control Points before setting the specified one; FALSE to leave the selected points alone.

Default Implementation:

{ }

{ }

virtual void PlugControllers ( TimeValue  t, BOOL  all  )

pure virtual