3ds Max C++ API Reference
ImpInterface Class Referenceabstract

#include <impapi.h>

+ Inheritance diagram for ImpInterface:

Public Member Functions

virtual ~ImpInterface ()
 
virtual ImpNodeCreateNode ()=0
 
virtual void RedrawViews ()=0
 
virtual GenCameraCreateCameraObject (int type)=0
 
virtual ObjectCreateTargetObject ()=0
 
virtual GenLightCreateLightObject (int type)=0
 
virtual voidCreate (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
 

Additional Inherited Members

- Static Public Member Functions inherited from MaxHeapOperators
static UtilExport voidoperator new (size_t size)
 Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, const std::nothrow_t &e)
 Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new (size_t size, const char *filename, int line)
 New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
 New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new (size_t size, unsigned long flags)
 New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, const std::nothrow_t &e, unsigned long flags)
 New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new[] (size_t size)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new[] (size_t size, const std::nothrow_t &e)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new[] (size_t size, const char *filename, int line)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects. More...
 
static UtilExport voidoperator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new[] (size_t size, unsigned long flags)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
 
static UtilExport void operator delete (void *ptr)
 Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e)
 Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete (void *ptr, const char *filename, int line)
 Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete (void *ptr, int block_type, const char *filename, int line)
 Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
 Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete (void *ptr, unsigned long flags)
 Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
 Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete[] (void *ptr)
 Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e)
 Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete[] (void *ptr, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete[] (void *ptr, int block_type, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete[] (void *ptr, unsigned long flags)
 Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
 Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, void *placement_ptr)
 Placement new operator. More...
 
static UtilExport void operator delete (void *ptr, void *placement_ptr)
 Placement delete operator. More...
 
static UtilExport voidaligned_malloc (size_t size, size_t alignment)
 Allocates memory on a specified alignment boundary. More...
 
static UtilExport voidaligned_realloc (void *ptr, size_t size, size_t alignment)
 Reallocates memory on a specified alignment boundary. More...
 
static UtilExport void aligned_free (void *ptr)
 Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...
 

Detailed 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.

Constructor & Destructor Documentation

◆ ~ImpInterface()

virtual ~ImpInterface ( )
inlinevirtual
113 {}

Member Function Documentation

◆ CreateNode()

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.

◆ RedrawViews()

virtual void RedrawViews ( )
pure virtual
Remarks
Redraws the 3ds Max viewports.

◆ CreateCameraObject()

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

◆ CreateTargetObject()

virtual Object* CreateTargetObject ( )
pure virtual
Remarks
Creates a target object and returns a pointer to it.

◆ CreateLightObject()

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

◆ Create()

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.

◆ BindToTarget()

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.

◆ AddNodeToScene()

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.

◆ SetAnimRange()

virtual void SetAnimRange ( Interval range)
pure virtual
Remarks
Sets the animation range for the node.
Parameters:
Interval& range

Specifies the animation range.

◆ GetAnimRange()

virtual Interval GetAnimRange ( )
pure virtual
Remarks
Retrieves the animation range for the node (as an Interval).

◆ SetEnvironmentMap()

virtual void SetEnvironmentMap ( Texmap txm)
pure virtual
Remarks
Sets the current environment map to the specified map.
Parameters:
Texmap *txm

The map to set.

◆ SetAmbient()

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.

◆ SetBackGround()

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.

◆ SetUseMap()

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.

◆ AddAtmosphere()

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.

◆ NewScene()

virtual int NewScene ( )
pure virtual
Remarks
This method deletes all existing geometry in the scene.

◆ TempFunc1()

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

◆ TempFunc2()

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

◆ TempFunc3()

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

◆ TempFunc4()

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

◆ TempFunc5()

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

◆ TempFunc6()

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

◆ TempFunc7()

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

◆ TempFunc8()

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

◆ TempFunc9()

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

◆ TempFunc10()

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

◆ DumpFile()

virtual FILE* DumpFile ( )
pure virtual