Skip to content

classDLLPlugin 03

Member Function Documentation

void DLLPlugin::Copy (  const DLLPlugin &  other  )  [inline, virtual]
 

This function is called any time the plugin "cache" is changed. Its purpose is to give you the chance to copy any member variables to the instances of the plugin. An example might be the seamless flag on a projection map, here's what that code looks like.

void CustomTexture::Copy( const DLLPlugin &other )
{
  CustomTexture *cache = &(CustomTexture &)other;
  isseamless = cache->isseamless;
}

Definition at line 38 of file DLLPlugi.h.

char * DLLPlugin::GetClassName (   )  [inline, virtual]
 

Your company name and a plugin description (separated by a "\\") should be returned by this function (for example, return "Hash\\BBall". This string is used as a unique identifier to reload this plugin upon the Project being reloaded by Animation Master. Because the descriptive name received by loading the string resource for the ID returned by GetNameID() is localized, it cannot be used for comparison purposes. This string should not be localized, remaining the same no matter what language the machine may be using.

Definition at line 45 of file DLLPlugi.h.

Referenced by ImageIO::Write().

UINT DLLPlugin::GetIconID (   )  [inline, virtual]
 

The resource ID for your plugin's icon should be returned by this function. A 32x32 and a 16x16 version should be created for the icon. The larger of the two will be shown as a preview for your plugin in the available plugin attribute pannel. When your plugin is chosen, it's small icon becomes visible in the Project Workspace.

Definition at line 42 of file DLLPlugi.h.

UINT DLLPlugin::GetNameID (   )  [inline, virtual]
 

This should be the resource ID of a string resource for the name of your plugin. An ID is used rather than text to aid in localization.

Definition at line 44 of file DLLPlugi.h.

virtual int DLLPlugin::GetNumProperties (   )  [inline, virtual]
 

Definition at line 48 of file DLLPlugi.h.

References GetPropertyAt().

Here is the call graph for this function:

HTreeObject* DLLPlugin::GetOwner (   )  [inline]
 

Definition at line 39 of file DLLPlugi.h.

References m_treeobject.

HProperty * DLLPlugin::GetPropertyAt (  int  i  )  [inline, virtual]
 

In order for a property to show in plugin property panel of the PWS, the HProperty derived class must be assigned an index.

GetPropertyAt is continuously called until you return NULL. The count parameter 'i' starts out at zero on the first call, and increments for each subsequent call. For each property you wish to add to the property panel, you return the pointer to the apporpriate HProperty derived class instance. For example:

HProperty *CustomTurbulence::GetPropertyAt( int i )
{
   switch (i) {
      case 0:
         return m_octaves;
      case 1:
         return m_density;
      case 2:
         return m_diameter;
      case 3:
         return m_euclid;
      default:
         return NULL;
   }
}
Parameters:
i  - The index value corresponds to the position of the property UI in the panel.
Returns:
You must return A pointer to the HProperty derived class instance associated to the index position;
Note:
important Whenever a group of properties have been added into a HCategoryProperty, the HCategoryProperty variable needs to be returned by GetPropertyAt call but not the properties included in the category.

Definition at line 47 of file DLLPlugi.h.

Referenced by GetNumProperties().

virtual HTreeObject** DLLPlugin::GetPtrAt (  int  index  )  [inline, virtual]
  Definition at line 61 of file DLLPlugi.h.

virtual void DLLPlugin::Init (  Time  time  )  [inline, virtual]
  Definition at line 37 of file DLLPlugi.h.

void DLLPlugin::Init (   )  [inline]
 

Definition at line 66 of file DLLPlugi.h.

References m_hresource.

Referenced by DLLPlugin().

virtual BOOL DLLPlugin::OnNotifyEndProjectLoad (  float  productversion  )  [inline, virtual]