ImpInterface Class Reference
 
 
 
ImpInterface Class Reference

#include <impapi.h>

Inheritance diagram for ImpInterface:
MaxHeapOperators

Class Description

See also:
Class ImpNode, Class Interval, Class_ID, Class GenLight, Class GenCamera.

Description:
Import Interface class. Methods of this class allow the plug-in to create nodes in the scene, create camera and light objects, and create objects by specifying a super class ID and Class ID. Methods are also available to bind target nodes to their Look At nodes. All methods of this class are implemented by the system.

Public Member Functions

virtual  ~ImpInterface ()
virtual ImpNode CreateNode ()=0
virtual void  RedrawViews ()=0
virtual GenCamera CreateCameraObject (int type)=0
virtual Object CreateTargetObject ()=0
virtual GenLight CreateLightObject (int type)=0
virtual void *  Create (SClass_ID sclass, Class_ID classid)=0
virtual int  BindToTarget (ImpNode *laNode, ImpNode *targNode)=0
virtual void  AddNodeToScene (ImpNode *node)=0
virtual void  SetAnimRange (Interval &range)=0
virtual Interval  GetAnimRange ()=0
virtual void  SetEnvironmentMap (Texmap *txm)=0
virtual void  SetAmbient (TimeValue t, Point3 col)=0
virtual void  SetBackGround (TimeValue t, Point3 col)=0
virtual void  SetUseMap (BOOL onoff)=0
virtual void  AddAtmosphere (Atmospheric *atmos)=0
virtual int  NewScene ()=0
virtual int  TempFunc1 (void *p1=NULL, void *p2=NULL, void *p3=NULL, void *p4=NULL, void *p5=NULL, void *p6=NULL, void *p7=NULL, void *p8=NULL)=0
virtual int  TempFunc2 (void *p1=NULL, void *p2=NULL, void *p3=NULL, void *p4=NULL, void *p5=NULL, void *p6=NULL, void *p7=NULL, void *p8=NULL)=0
virtual int  TempFunc3 (void *p1=NULL, void *p2=NULL, void *p3=NULL, void *p4=NULL, void *p5=NULL, void *p6=NULL, void *p7=NULL, void *p8=NULL)=0
virtual int  TempFunc4 (void *p1=NULL, void *p2=NULL, void *p3=NULL, void *p4=NULL, void *p5=NULL, void *p6=NULL, void *p7=NULL, void *p8=NULL)=0
virtual int  TempFunc5 (void *p1=NULL, void *p2=NULL, void *p3=NULL, void *p4=NULL, void *p5=NULL, void *p6=NULL, void *p7=NULL, void *p8=NULL)=0
virtual int  TempFunc6 (void *p1=NULL, void *p2=NULL, void *p3=NULL, void *p4=NULL, void *p5=NULL, void *p6=NULL, void *p7=NULL, void *p8=NULL)=0
virtual int  TempFunc7 (void *p1=NULL, void *p2=NULL, void *p3=NULL, void *p4=NULL, void *p5=NULL, void *p6=NULL, void *p7=NULL, void *p8=NULL)=0
virtual int  TempFunc8 (void *p1=NULL, void *p2=NULL, void *p3=NULL, void *p4=NULL, void *p5=NULL, void *p6=NULL, void *p7=NULL, void *p8=NULL)=0
virtual int  TempFunc9 (void *p1=NULL, void *p2=NULL, void *p3=NULL, void *p4=NULL, void *p5=NULL, void *p6=NULL, void *p7=NULL, void *p8=NULL)=0
virtual int  TempFunc10 (void *p1=NULL, void *p2=NULL, void *p3=NULL, void *p4=NULL, void *p5=NULL, void *p6=NULL, void *p7=NULL, void *p8=NULL)=0
virtual FILE *  DumpFile ()=0

Constructor & Destructor Documentation

virtual ~ImpInterface ( ) [inline, virtual]
{}

Member Function Documentation

virtual ImpNode* CreateNode ( ) [pure virtual]
Remarks:
Creates a new node. Methods of ImpNode may be used to assign properties to the node. See AddNodeToScene() to add a node to the scene given its ImpNode pointer.
Returns:
An ImpNode pointer that may be used to set properties of the node.
virtual void RedrawViews ( ) [pure virtual]
Remarks:
Redraws the 3ds Max viewports.
virtual GenCamera* CreateCameraObject ( int  type ) [pure virtual]
Remarks:
Creates a camera object and returns a pointer to it. The GenCamera pointer may be used to set the properties of the camera object.
Parameters:
int type

One of the following values:

FREE_CAMERA

TARGETED_CAMERA
virtual Object* CreateTargetObject ( ) [pure virtual]
Remarks:
Creates a target object and returns a pointer to it.
virtual GenLight* CreateLightObject ( int  type ) [pure virtual]
Remarks:
Creates a light object and returns a pointer to it. The GenLight pointer may be used to set the properties of the light object.
Parameters:
int type

One of the following values:

OMNI_LIGHT - Omnidirectional

TSPOT_LIGHT - Targeted

DIR_LIGHT - Directional

FSPOT_LIGHT - Free
virtual void* Create ( SClass_ID  sclass,
Class_ID  classid 
) [pure virtual]
Remarks:
Creates an object given its Super Class ID and its Class ID.
Parameters:
SClass_ID sclass

The super class ID of the node to create.

Class_ID classid

The unique class ID of the node to create.
Returns:
A pointer to the item.
virtual int BindToTarget ( ImpNode laNode,
ImpNode targNode 
) [pure virtual]
Remarks:
This method binds a node to a target using a Look At controller. This is typically used with target spotlights and cameras to bind them to their target node.
Parameters:
ImpNode *laNode

The node that will have the Look At controller assigned.

ImpNode *targNode

The target node.
Returns:
Nonzero if successful; otherwise 0.
virtual void AddNodeToScene ( ImpNode node ) [pure virtual]
Remarks:
Adds a node to the scene given its ImpNode pointer.
Parameters:
ImpNode *node

The node to add to the scene.
virtual void SetAnimRange ( Interval range ) [pure virtual]
Remarks:
Sets the animation range for the node.
Parameters:
Interval& range

Specifies the animation range.
virtual Interval GetAnimRange ( ) [pure virtual]
Remarks:
Retrieves the animation range for the node (as an Interval).
virtual void SetEnvironmentMap ( Texmap txm ) [pure virtual]
Remarks:
Sets the current environment map to the specified map.
Parameters:
Texmap *txm

The map to set.
virtual void SetAmbient ( TimeValue  t,
Point3  col 
) [pure virtual]
Remarks:
Sets the ambient light color at the specified time.
Parameters:
TimeValue t

The time to set the color.

Point3 col

The light color to set.
virtual void SetBackGround ( TimeValue  t,
Point3  col 
) [pure virtual]
Remarks:
Sets the background color at the specified time.
Parameters:
TimeValue t

The time to set the color.

Point3 col

The light color to set.
virtual void SetUseMap ( BOOL  onoff ) [pure virtual]
Remarks:
Sets the state of the environment 'Use Map' toggle.
Parameters:
BOOL onoff

TRUE to turn on; FALSE to turn off.
virtual void AddAtmosphere ( Atmospheric atmos ) [pure virtual]
Remarks:
Adds the specified atmospheric effect to the environment.
Parameters:
Atmospheric *atmos

The atmospheric effect. See Class Atmospheric.
virtual int NewScene ( ) [pure virtual]
Remarks:
This method deletes all existing geometry in the scene.
virtual int TempFunc1 ( void *  p1 = NULL,
void *  p2 = NULL,
void *  p3 = NULL,
void *  p4 = NULL,
void *  p5 = NULL,
void *  p6 = NULL,
void *  p7 = NULL,
void *  p8 = NULL 
) [pure virtual]
virtual int TempFunc2 ( void *  p1 = NULL,
void *  p2 = NULL,
void *  p3 = NULL,
void *  p4 = NULL,
void *  p5 = NULL,
void *  p6 = NULL,
void *  p7 = NULL,
void *  p8 = NULL 
) [pure virtual]
virtual int TempFunc3 ( void *  p1 = NULL,
void *  p2 = NULL,
void *  p3 = NULL,
void *  p4 = NULL,
void *  p5 = NULL,
void *  p6 = NULL,
void *  p7 = NULL,
void *  p8 = NULL 
) [pure virtual]
virtual int TempFunc4 ( void *  p1 = NULL,
void *  p2 = NULL,
void *  p3 = NULL,
void *  p4 = NULL,
void *  p5 = NULL,
void *  p6 = NULL,
void *  p7 = NULL,
void *  p8 = NULL 
) [pure virtual]
virtual int TempFunc5 ( void *  p1 = NULL,
void *  p2 = NULL,
void *  p3 = NULL,
void *  p4 = NULL,
void *  p5 = NULL,
void *  p6 = NULL,
void *  p7 = NULL,
void *  p8 = NULL 
) [pure virtual]
virtual int TempFunc6 ( void *  p1 = NULL,
void *  p2 = NULL,
void *  p3 = NULL,
void *  p4 = NULL,
void *  p5 = NULL,
void *  p6 = NULL,
void *  p7 = NULL,
void *  p8 = NULL 
) [pure virtual]
virtual int TempFunc7 ( void *  p1 = NULL,
void *  p2 = NULL,
void *  p3 = NULL,
void *  p4 = NULL,
void *  p5 = NULL,
void *  p6 = NULL,
void *  p7 = NULL,
void *  p8 = NULL 
) [pure virtual]
virtual int TempFunc8 ( void *  p1 = NULL,
void *  p2 = NULL,
void *  p3 = NULL,
void *  p4 = NULL,
void *  p5 = NULL,
void *  p6 = NULL,
void *  p7 = NULL,
void *  p8 = NULL 
) [pure virtual]
virtual int TempFunc9 ( void *  p1 = NULL,
void *  p2 = NULL,
void *  p3 = NULL,
void *  p4 = NULL,
void *  p5 = NULL,
void *  p6 = NULL,
void *  p7 = NULL,
void *  p8 = NULL 
) [pure virtual]
virtual int TempFunc10 ( void *  p1 = NULL,
void *  p2 = NULL,
void *  p3 = NULL,
void *  p4 = NULL,
void *  p5 = NULL,
void *  p6 = NULL,
void *  p7 = NULL,
void *  p8 = NULL 
) [pure virtual]
virtual FILE* DumpFile ( ) [pure virtual]