IUnwrapMod Class Reference

IUnwrapMod Class Referenceabstract

#include <iunwrap.h>

Class Description

See also
Class Modifier, Class FPStaticInterface

Description:
This class represents the interface to the UVW Unwrap Modifier. You can obtain a pointer to the UVW Unwrap Modifier interface using; GetIUnwrapInterface(cd). This macro will return

(IUnwrapMod *)(cd)->GetFPInterace(UNWRAP_INTERFACE). Sample code supporting this class can be found in /MAXSDK/SAMPLES/MODIFIERS/UVWUNWRAP

All methods of this class are Implemented by the System.
+ Inheritance diagram for IUnwrapMod:

Public Member Functions

 VFN_0 (unwrap_planarmap, fnPlanarMap)
 
 VFN_0 (unwrap_save, fnSave)
 
 VFN_0 (unwrap_load, fnLoad)
 
 VFN_0 (unwrap_reset, fnReset)
 
 VFN_0 (unwrap_edit, fnEdit)
 
 VFN_1 (unwrap_setMapChannel, fnSetMapChannel, TYPE_INT)
 
 FN_0 (unwrap_getMapChannel, TYPE_INT, fnGetMapChannel)
 
 VFN_1 (unwrap_setProjectionType, fnSetProjectionType, TYPE_INT)
 
 FN_0 (unwrap_getProjectionType, TYPE_INT, fnGetProjectionType)
 
 VFN_1 (unwrap_setVC, fnSetVC, TYPE_BOOL)
 
 FN_0 (unwrap_getVC, TYPE_BOOL, fnGetVC)
 
 VFN_0 (unwrap_move, fnMove)
 
 VFN_0 (unwrap_moveh, fnMoveH)
 
 VFN_0 (unwrap_movev, fnMoveV)
 
 VFN_0 (unwrap_rotate, fnRotate)
 
 VFN_0 (unwrap_scale, fnScale)
 
 VFN_0 (unwrap_scaleh, fnScaleH)
 
 VFN_0 (unwrap_scalev, fnScaleV)
 
 VFN_0 (unwrap_mirrorh, fnMirrorH)
 
 VFN_0 (unwrap_mirrorv, fnMirrorV)
 
 VFN_0 (unwrap_expandsel, fnExpandSelection)
 
 VFN_0 (unwrap_contractsel, fnContractSelection)
 
 VFN_1 (unwrap_setFalloffType, fnSetFalloffType, TYPE_INT)
 
 FN_0 (unwrap_getFalloffType, TYPE_INT, fnGetFalloffType)
 
 VFN_1 (unwrap_setFalloffSpace, fnSetFalloffSpace, TYPE_INT)
 
 FN_0 (unwrap_getFalloffSpace, TYPE_INT, fnGetFalloffSpace)
 
 VFN_1 (unwrap_setFalloffDist, fnSetFalloffDist, TYPE_FLOAT)
 
 FN_0 (unwrap_getFalloffDist, TYPE_FLOAT, fnGetFalloffDist)
 
 VFN_0 (unwrap_breakselected, fnBreakSelected)
 
 VFN_0 (unwrap_weld, fnWeld)
 
 VFN_0 (unwrap_weldselected, fnWeldSelected)
 
 VFN_0 (unwrap_updatemap, fnUpdatemap)
 
 VFN_1 (unwrap_displaymap, fnDisplaymap, TYPE_BOOL)
 
 FN_0 (unwrap_ismapdisplayed, TYPE_BOOL, fnIsMapDisplayed)
 
 VFN_1 (unwrap_setuvspace, fnSetUVSpace, TYPE_INT)
 
 FN_0 (unwrap_getuvspace, TYPE_INT, fnGetUVSpace)
 
 VFN_0 (unwrap_options, fnOptions)
 
 VFN_0 (unwrap_lock, fnLock)
 
 VFN_0 (unwrap_hide, fnHide)
 
 VFN_0 (unwrap_unhide, fnUnhide)
 
 VFN_0 (unwrap_freeze, fnFreeze)
 
 VFN_0 (unwrap_thaw, fnThaw)
 
 VFN_0 (unwrap_filterselected, fnFilterSelected)
 
 VFN_0 (unwrap_pan, fnPan)
 
 VFN_0 (unwrap_zoom, fnZoom)
 
 VFN_0 (unwrap_zoomregion, fnZoomRegion)
 
 VFN_0 (unwrap_fit, fnFit)
 
 VFN_0 (unwrap_fitselected, fnFitSelected)
 
 VFN_0 (unwrap_snaptoggle, fnSnapToggle)
 
 FN_0 (unwrap_getcurrentmap, TYPE_INT, fnGetCurrentMap)
 
 VFN_1 (unwrap_setcurrentmap, fnSetCurrentMap, TYPE_INT)
 
 FN_0 (unwrap_numbermaps, TYPE_INT, fnNumberMaps)
 
 FN_0 (unwrap_getlinecolor, TYPE_POINT3, fnGetLineColor)
 
 VFN_1 (unwrap_setlinecolor, fnSetLineColor, TYPE_POINT3)
 
 FN_0 (unwrap_getselectioncolor, TYPE_POINT3, fnGetSelColor)
 
 VFN_1 (unwrap_setselectioncolor, fnSetSelColor, TYPE_POINT3)
 
 FN_0 (unwrap_getrenderwidth, TYPE_INT, fnGetRenderWidth)
 
 VFN_1 (unwrap_setrenderwidth, fnSetRenderWidth, TYPE_INT)
 
 FN_0 (unwrap_getrenderheight, TYPE_INT, fnGetRenderHeight)
 
 VFN_1 (unwrap_setrenderheight, fnSetRenderHeight, TYPE_INT)
 
 FN_0 (unwrap_getusebitmapres, TYPE_BOOL, fnGetUseBitmapRes)
 
 VFN_1 (unwrap_setusebitmapres, fnSetUseBitmapRes, TYPE_BOOL)
 
 FN_0 (unwrap_getweldtheshold, TYPE_FLOAT, fnGetWeldThresold)
 
 VFN_1 (unwrap_setweldtheshold, fnSetWeldThreshold, TYPE_FLOAT)
 
 FN_0 (unwrap_getconstantupdate, TYPE_BOOL, fnGetConstantUpdate)
 
 VFN_1 (unwrap_setconstantupdate, fnSetConstantUpdate, TYPE_BOOL)
 
 FN_0 (unwrap_getshowselectedvertices, TYPE_BOOL, fnGetShowSelectedVertices)
 
 VFN_1 (unwrap_setshowselectedvertices, fnSetShowSelectedVertices, TYPE_BOOL)
 
 FN_0 (unwrap_getmidpixelsnap, TYPE_BOOL, fnGetPixelCenterSnape)
 
 VFN_1 (unwrap_setmidpixelsnap, fnSetPixelCenterSnape, TYPE_BOOL)
 
 FN_0 (unwrap_getmatid, TYPE_INT, fnGetMatID)
 
 VFN_1 (unwrap_setmatid, fnSetMatID, TYPE_INT)
 
 FN_0 (unwrap_numbermatids, TYPE_INT, fnNumberMatIDs)
 
 FN_0 (unwrap_getselectedverts, TYPE_BITARRAY, fnGetSelectedVerts)
 
 VFN_1 (unwrap_selectverts, fnSelectVerts, TYPE_BITARRAY)
 
 FN_1 (unwrap_isvertexselected, TYPE_BOOL, fnIsVertexSelected, TYPE_INT)
 
 VFN_1 (unwrap_moveselectedvertices, fnMoveSelectedVertices, TYPE_POINT3)
 
 VFN_1 (unwrap_rotateselectedverticesc, fnRotateSelectedVertices, TYPE_FLOAT)
 
 VFN_2 (unwrap_rotateselectedvertices, fnRotateSelectedVertices, TYPE_FLOAT, TYPE_POINT3)
 
 VFN_2 (unwrap_scaleselectedverticesc, fnScaleSelectedVertices, TYPE_FLOAT, TYPE_INT)
 
 VFN_3 (unwrap_scaleselectedvertices, fnScaleSelectedVertices, TYPE_FLOAT, TYPE_INT, TYPE_POINT3)
 
 FN_2 (unwrap_getvertexposition, TYPE_POINT3, fnGetVertexPosition, TYPE_TIMEVALUE, TYPE_INT)
 
 FN_0 (unwrap_numbervertices, TYPE_INT, fnNumberVertices)
 
 VFN_1 (unwrap_movex, fnMoveX, TYPE_FLOAT)
 
 VFN_1 (unwrap_movey, fnMoveY, TYPE_FLOAT)
 
 VFN_1 (unwrap_movez, fnMoveZ, TYPE_FLOAT)
 
 FN_0 (unwrap_getselectedpolygons, TYPE_BITARRAY, fnGetSelectedPolygons)
 
 VFN_1 (unwrap_selectpolygons, fnSelectPolygons, TYPE_BITARRAY)
 
 FN_1 (unwrap_ispolygonselected, TYPE_BOOL, fnIsPolygonSelected, TYPE_INT)
 
 FN_0 (unwrap_numberpolygons, TYPE_INT, fnNumberPolygons)
 
 VFN_0 (unwrap_detachedgeverts, fnDetachEdgeVerts)
 
 VFN_0 (unwrap_fliph, fnFlipH)
 
 VFN_0 (unwrap_flipv, fnFlipV)
 
 VFN_1 (unwrap_setlockaspect, fnSetLockAspect, TYPE_BOOL)
 
 FN_0 (unwrap_getlockaspect, TYPE_BOOL, fnGetLockAspect)
 
 VFN_1 (unwrap_setmapscale, fnSetMapScale, TYPE_FLOAT)
 
 FN_0 (unwrap_getmapscale, TYPE_FLOAT, fnGetMapScale)
 
 VFN_0 (unwrap_getselectionfromface, fnGetSelectionFromFace)
 
 VFN_1 (unwrap_forceupdate, fnForceUpdate, TYPE_BOOL)
 
 VFN_1 (unwrap_zoomtogizmo, fnZoomToGizmo, TYPE_BOOL)
 
 VFN_3 (unwrap_setvertexposition, fnSetVertexPosition, TYPE_TIMEVALUE, TYPE_INT, TYPE_POINT3)
 
 VFN_1 (unwrap_markasdead, fnMarkAsDead, TYPE_INT)
 
 FN_1 (unwrap_numberpointsinface, TYPE_INT, fnNumberPointsInFace, TYPE_INT)
 
 FN_2 (unwrap_getvertexindexfromface, TYPE_INT, fnGetVertexIndexFromFace, TYPE_INT, TYPE_INT)
 
 FN_2 (unwrap_gethandleindexfromface, TYPE_INT, fnGetHandleIndexFromFace, TYPE_INT, TYPE_INT)
 
 FN_2 (unwrap_getinteriorindexfromface, TYPE_INT, fnGetInteriorIndexFromFace, TYPE_INT, TYPE_INT)
 
 FN_2 (unwrap_getvertexgindexfromface, TYPE_INT, fnGetVertexGIndexFromFace, TYPE_INT, TYPE_INT)
 
 FN_2 (unwrap_gethandlegindexfromface, TYPE_INT, fnGetHandleGIndexFromFace, TYPE_INT, TYPE_INT)
 
 FN_2 (unwrap_getinteriorgindexfromface, TYPE_INT, fnGetInteriorGIndexFromFace, TYPE_INT, TYPE_INT)
 
 VFN_4 (unwrap_addpointtoface, fnAddPoint, TYPE_POINT3, TYPE_INT, TYPE_INT, TYPE_BOOL)
 
 VFN_4 (unwrap_addpointtohandle, fnAddHandle, TYPE_POINT3, TYPE_INT, TYPE_INT, TYPE_BOOL)
 
 VFN_4 (unwrap_addpointtointerior, fnAddInterior, TYPE_POINT3, TYPE_INT, TYPE_INT, TYPE_BOOL)
 
 VFN_3 (unwrap_setfacevertexindex, fnSetFaceVertexIndex, TYPE_INT, TYPE_INT, TYPE_INT)
 
 VFN_3 (unwrap_setfacehandleindex, fnSetFaceHandleIndex, TYPE_INT, TYPE_INT, TYPE_INT)
 
 VFN_3 (unwrap_setfaceinteriorindex, fnSetFaceInteriorIndex, TYPE_INT, TYPE_INT, TYPE_INT)
 
 VFN_0 (unwrap_updateview, fnUpdateViews)
 
 VFN_0 (unwrap_getfaceselfromstack, fnGetFaceSelFromStack)
 
FPInterfaceDescGetDesc ()
 
virtual void fnPlanarMap ()=0
 
virtual void fnSave ()=0
 
virtual void fnLoad ()=0
 
virtual void fnReset ()=0
 
virtual void fnEdit ()=0
 
virtual void fnSetMapChannel (int channel)=0
 
virtual int fnGetMapChannel ()=0
 
virtual void fnSetProjectionType (int proj)=0
 
virtual int fnGetProjectionType ()=0
 
virtual void fnSetVC (BOOL vc)=0
 
virtual BOOL fnGetVC ()=0
 
virtual void fnMove ()=0
 
virtual void fnMoveH ()=0
 
virtual void fnMoveV ()=0
 
virtual void fnRotate ()=0
 
virtual void fnScale ()=0
 
virtual void fnScaleH ()=0
 
virtual void fnScaleV ()=0
 
virtual void fnMirrorH ()=0
 
virtual void fnMirrorV ()=0
 
virtual void fnExpandSelection ()=0
 
virtual void fnContractSelection ()=0
 
virtual void fnSetFalloffType (int falloff)=0
 
virtual int fnGetFalloffType ()=0
 
virtual void fnSetFalloffSpace (int space)=0
 
virtual int fnGetFalloffSpace ()=0
 
virtual void fnSetFalloffDist (float dist)=0
 
virtual float fnGetFalloffDist ()=0
 
virtual void fnBreakSelected ()=0
 
virtual void fnWeld ()=0
 
virtual void fnWeldSelected ()=0
 
virtual void fnUpdatemap ()=0
 
virtual void fnDisplaymap (BOOL update)=0
 
virtual BOOL fnIsMapDisplayed ()=0
 
virtual void fnSetUVSpace (int space)=0
 
virtual int fnGetUVSpace ()=0
 
virtual void fnOptions ()=0
 
virtual void fnLock ()=0
 
virtual void fnHide ()=0
 
virtual void fnUnhide ()=0
 
virtual void fnFreeze ()=0
 
virtual void fnThaw ()=0
 
virtual void fnFilterSelected ()=0
 
virtual void fnPan ()=0
 
virtual void fnZoom ()=0
 
virtual void fnZoomRegion ()=0
 
virtual void fnFit ()=0
 
virtual void fnFitSelected ()=0
 
virtual void fnSnapToggle ()=0
 
virtual int fnGetCurrentMap ()=0
 
virtual void fnSetCurrentMap (int map)=0
 
virtual int fnNumberMaps ()=0
 
virtual Point3fnGetLineColor ()=0
 
virtual void fnSetLineColor (Point3 color)=0
 
virtual Point3fnGetSelColor ()=0
 
virtual void fnSetSelColor (Point3 color)=0
 
virtual void fnSetRenderWidth (int dist)=0
 
virtual int fnGetRenderWidth ()=0
 
virtual void fnSetRenderHeight (int dist)=0
 
virtual int fnGetRenderHeight ()=0
 
virtual void fnSetWeldThreshold (float dist)=0
 
virtual float fnGetWeldThresold ()=0
 
virtual void fnSetUseBitmapRes (BOOL useBitmapRes)=0
 
virtual BOOL fnGetUseBitmapRes ()=0
 
virtual BOOL fnGetConstantUpdate ()=0
 
virtual void fnSetConstantUpdate (BOOL constantUpdates)=0
 
virtual BOOL fnGetShowSelectedVertices ()=0
 
virtual void fnSetShowSelectedVertices (BOOL show)=0
 
virtual BOOL fnGetPixelCenterSnape ()=0
 
virtual void fnSetPixelCenterSnape (BOOL midPixel)=0
 
virtual int fnGetMatID ()=0
 
virtual void fnSetMatID (int matid)=0
 
virtual int fnNumberMatIDs ()=0
 
virtual BitArrayfnGetSelectedVerts ()=0
 
virtual void fnSelectVerts (BitArray *sel)=0
 
virtual BOOL fnIsVertexSelected (int index)=0
 
virtual void fnMoveSelectedVertices (Point3 offset)=0
 
virtual void fnRotateSelectedVertices (float angle)=0
 
virtual void fnRotateSelectedVertices (float angle, Point3 axis)=0
 
virtual void fnScaleSelectedVertices (float scale, int dir)=0
 
virtual void fnScaleSelectedVertices (float scale, int dir, Point3 axis)=0
 
virtual Point3fnGetVertexPosition (TimeValue t, int index)=0
 
virtual int fnNumberVertices ()=0
 
virtual void fnMoveX (float p)=0
 
virtual void fnMoveY (float p)=0
 
virtual void fnMoveZ (float p)=0
 
virtual BitArrayfnGetSelectedPolygons ()=0
 
virtual void fnSelectPolygons (BitArray *sel)=0
 
virtual BOOL fnIsPolygonSelected (int index)=0
 
virtual int fnNumberPolygons ()=0
 
virtual void fnDetachEdgeVerts ()=0
 
virtual void fnFlipH ()=0
 
virtual void fnFlipV ()=0
 
virtual BOOL fnGetLockAspect ()=0
 
virtual void fnSetLockAspect (BOOL a)=0
 
virtual float fnGetMapScale ()=0
 
virtual void fnSetMapScale (float sc)=0
 
virtual void fnGetSelectionFromFace ()=0
 
virtual void fnForceUpdate (BOOL update)=0
 
virtual void fnZoomToGizmo (BOOL all)=0
 
virtual void fnSetVertexPosition (TimeValue t, int index, Point3 pos)=0
 
virtual void fnMarkAsDead (int index)=0
 
virtual int fnNumberPointsInFace (int index)=0
 
virtual int fnGetVertexIndexFromFace (int index, int vertexIndex)=0
 
virtual int fnGetHandleIndexFromFace (int index, int vertexIndex)=0
 
virtual int fnGetInteriorIndexFromFace (int index, int vertexIndex)=0
 
virtual int fnGetVertexGIndexFromFace (int index, int vertexIndex)=0
 
virtual int fnGetHandleGIndexFromFace (int index, int vertexIndex)=0
 
virtual int fnGetInteriorGIndexFromFace (int index, int vertexIndex)=0
 
virtual void fnAddPoint (Point3 pos, int fIndex, int ithV, BOOL sel)=0
 
virtual void fnAddHandle (Point3 pos, int fIndex, int ithV, BOOL sel)=0
 
virtual void fnAddInterior (Point3 pos, int fIndex, int ithV, BOOL sel)=0
 
virtual void fnSetFaceVertexIndex (int fIndex, int ithV, int vIndex)=0
 
virtual void fnSetFaceHandleIndex (int fIndex, int ithV, int vIndex)=0
 
virtual void fnSetFaceInteriorIndex (int fIndex, int ithV, int vIndex)=0
 
virtual void fnUpdateViews ()=0
 
virtual void fnGetFaceSelFromStack ()=0
 
- Public Member Functions inherited from Modifier
CoreExport Modifier ()
 
CoreExport ~Modifier ()
 
SClass_ID SuperClassID ()
 Retrieves a constant representing the type of the plugin. More...
 
MAX_DEPRECATED int NeedUseSubselButton ()
 
virtual void ForceNotify (Interval &i)
 Notifies dependents of a change. More...
 
CoreExport SvGraphNodeReference SvTraverseAnimGraph (IGraphObjectManager *gom, Animatable *owner, int id, DWORD flags)
 
CoreExport MSTR SvGetName (IGraphObjectManager *gom, IGraphNode *gNode, bool isBeingEdited)
 
CoreExport bool SvCanSetName (IGraphObjectManager *gom, IGraphNode *gNode)
 
CoreExport bool SvSetName (IGraphObjectManager *gom, IGraphNode *gNode, const MSTR &name)
 
CoreExport bool SvHandleDoubleClick (IGraphObjectManager *gom, IGraphNode *gNode)
 
CoreExport COLORREF SvHighlightColor (IGraphObjectManager *gom, IGraphNode *gNode)
 
CoreExport bool SvIsSelected (IGraphObjectManager *gom, IGraphNode *gNode)
 Returns true if the object is selected in its schematic view. More...
 
CoreExport MultiSelectCallbackSvGetMultiSelectCallback (IGraphObjectManager *gom, IGraphNode *gNode)
 
CoreExport bool SvCanSelect (IGraphObjectManager *gom, IGraphNode *gNode)
 
CoreExport bool SvCanInitiateLink (IGraphObjectManager *gom, IGraphNode *gNode)
 
CoreExport bool SvCanConcludeLink (IGraphObjectManager *gom, IGraphNode *gNode, IGraphNode *gNodeChild)
 
CoreExport bool SvLinkChild (IGraphObjectManager *gom, IGraphNode *gNodeThis, IGraphNode *gNodeChild)
 
CoreExport bool SvCanRemoveThis (IGraphObjectManager *gom, IGraphNode *gNode)
 
CoreExport bool SvRemoveThis (IGraphObjectManager *gom, IGraphNode *gNode)
 Called when the user deletes this object in the schematic view... More...
 
virtual CoreExport MSTR GetName ()
 Implemented by the System. More...
 
virtual CoreExport void SetName (MSTR n)
 Implemented by the System. More...
 
void DisableModApps ()
 This method is used internally. More...
 
void EnableModApps ()
 This method is used internally. More...
 
void DisableMod ()
 Implemented by the System. More...
 
void EnableMod ()
 Implemented by the System. More...
 
int IsEnabled ()
 Implemented by the System. More...
 
void DisableModInViews ()
 Implemented by the System. More...
 
void EnableModInViews ()
 Implemented by the System. More...
 
int IsEnabledInViews ()
 Implemented by the System. More...
 
void DisableModInRender ()
 Implemented by the System. More...
 
void EnableModInRender ()
 Implemented by the System. More...
 
int IsEnabledInRender ()
 Implemented by the System. More...
 
virtual CoreExport Interval LocalValidity (TimeValue t)
 This method returns the validity interval of a modifier. More...
 
virtual ChannelMask ChannelsUsed ()=0
 These are channels that the modifier needs in order to perform its modification. More...
 
virtual ChannelMask ChannelsChanged ()=0
 These are the channels that the modifier actually modifies. More...
 
virtual bool ChangesSelType ()
 If a modifier want to make it possible to switch dynamically between changing the selection type that flows up the stack, or leaving it like it is, it can overwrite this. More...
 
CoreExport ChannelMask TotalChannelsUsed ()
 Returns the same value as ChannelsUsed() above except GFX_DATA_CHANNEL will be ORed in if the TOPO_CHANNEL or the TEXMAP_CHANNEL are being used. More...
 
CoreExport ChannelMask TotalChannelsChanged ()
 Returns the same value as ChannelsChanged() above except GFX_DATA_CHANNEL will be ORed in if the TOPO_CHANNEL, the TEXMAP_CHANNEL , or the VERTCOLOR_CHANNEL are being changed. More...
 
virtual Class_ID InputType ()=0
 This is the type of object that the modifier knows how to modify. More...
 
virtual void NotifyInputChanged (const Interval &changeInt, PartID partID, RefMessage message, ModContext *mc)
 This method is called when an item in the modifier stack before this modifier sends a REFMSG_CHANGE message via NotifyDependents(). More...
 
virtual void ModifyObject (TimeValue t, ModContext &mc, ObjectState *os, INode *node)=0
 This is the method that actually modifies the input object. More...
 
virtual BOOL DependOnTopology (ModContext &mc)
 Modifiers that place a dependency on topology should return TRUE for this method. More...
 
virtual IOResult SaveLocalData (ISave *isave, LocalModData *ld)
 When a 3ds Max file is being saved, this method is called so that the modifier can save the localData structure that is hung off each ModContext. More...
 
virtual IOResult LoadLocalData (ILoad *iload, LocalModData **pld)
 When a 3ds Max file is being loaded, this method is called so that the modifier can load the LocalModData structure that is hung off each ModContext. More...
 
CoreExport IOResult Save (ISave *isave)
 Implemented by the System. More...
 
CoreExport IOResult Load (ILoad *iload)
 Implemented by the System. More...
 
CoreExport void EnumModContexts (ModContextEnumProc *proc)
 Implemented by the System. More...
 
CoreExport void GetIDerivedObject (ModContext *mc, IDerivedObject *&derObj, int &modIndex)
 This method will retrieve the IDerivedObject and index of this modifier for a given modifier context. More...
 
virtual CoreExport void CopyAdditionalChannels (Object *fromObj, Object *toObj)
 In case the modifier changes the object type (basically the os->obj pointer in ModifyObject) and changes the ExtensionChannel, it has to overwrite this method and copy only the channels that it doesn't modify/added already to the new object. More...
 
- Public Member Functions inherited from BaseObject
virtual CoreExport unsigned long GetObjectDisplayRequirement () const
 
virtual CoreExport bool PrepareDisplay (const MaxSDK::Graphics::UpdateDisplayContext &prepareDisplayContext)
 
virtual CoreExport bool UpdatePerNodeItems (const MaxSDK::Graphics::UpdateDisplayContext &updateDisplayContext, MaxSDK::Graphics::UpdateNodeContext &nodeContext, MaxSDK::Graphics::IRenderItemContainer &targetRenderItemContainer)
 
virtual CoreExport bool UpdatePerViewItems (const MaxSDK::Graphics::UpdateDisplayContext &updateDisplayContext, MaxSDK::Graphics::UpdateNodeContext &nodeContext, MaxSDK::Graphics::UpdateViewContext &viewContext, MaxSDK::Graphics::IRenderItemContainer &targetRenderItemContainer)
 
virtual CoreExport const MaxSDK::Graphics::RenderItemHandleArrayGetRenderItems () const
 
virtual CoreExport voidGetInterface (ULONG id)
 Inherited from Animatable. More...
 
virtual CoreExport BaseInterfaceGetInterface (Interface_ID id)
 Inherited from Animatable. More...
 
CoreExport BaseObject ()
 
virtual CoreExport ~BaseObject ()
 
virtual BOOL HasViewDependentBoundingBox ()
 This method return true if GetWorldBoundBox returns different boxes for different viewports. More...
 
virtual int HitTest (TimeValue t, INode *inode, int type, int crossing, int flags, IPoint2 *p, ViewExp *vpt)
 This method is called to determine if the specified screen point intersects the item. More...
 
virtual void SetExtendedDisplay (int flags)
 This method is used for storing mode-dependent display attributes. More...
 
virtual int Display (TimeValue t, INode *inode, ViewExp *vpt, int flags)
 This is called by the system to have the item display itself (perform a quick render in viewport, using the current TM). More...
 
virtual void Snap (TimeValue t, INode *inode, SnapInfo *snap, IPoint2 *p, ViewExp *vpt)
 Checks the point passed for a snap and updates the SnapInfo structure. More...
 
virtual void GetWorldBoundBox (TimeValue t, INode *inode, ViewExp *vp, Box3 &box)
 This method returns the world space bounding box for Objects (see below for the Sub-object gizmo or Modifiers gizmo version). More...
 
virtual void GetLocalBoundBox (TimeValue t, INode *inode, ViewExp *vp, Box3 &box)
 This is the object space bounding box, the box in the object's local coordinates. More...
 
virtual CreateMouseCallBackGetCreateMouseCallBack ()=0
 This method allows the system to retrieve a callback object used in creating an object in the 3D viewports. More...
 
virtual const MCHARGetObjectName ()
 
virtual CoreExport BOOL OKToChangeTopology (MSTR &modName)
 Implemented by the System. More...
 
virtual BOOL ChangeTopology ()
 This method asks the question of an object or modifier "Do you change topology"? An object or modifier returns TRUE if it is capable of changing topology when its parameters are being edited; otherwise FALSE. More...
 
virtual IParamArrayGetParamBlock ()
 An object or modifier should implement this method if it wishes to make its parameter block available for other plug-ins to access it. More...
 
virtual int GetParamBlockIndex (int id)
 If a plug-in makes its parameter block available (using GetParamBlock()) then it will need to provide #defines for indices into the parameter block. More...
 
virtual void Move (TimeValue t, Matrix3 &partm, Matrix3 &tmAxis, Point3 &val, BOOL localOrigin=FALSE)
 When this method is called the plug-in should respond by moving its selected sub-object components. More...
 
virtual void Rotate (TimeValue t, Matrix3 &partm, Matrix3 &tmAxis, Quat &val, BOOL localOrigin=FALSE)
 When this method is called the plug-in should respond by rotating its selected sub-object components. More...
 
virtual void Scale (TimeValue t, Matrix3 &partm, Matrix3 &tmAxis, Point3 &val, BOOL localOrigin=FALSE)
 When this method is called the plug-in should respond by scaling its selected sub-object components. More...
 
virtual void TransformStart (TimeValue t)
 This method is called before the first Move(), Rotate() or Scale() call and before a hold is in effect. More...
 
virtual void TransformHoldingStart (TimeValue t)
 This method is called before the first Move(), Rotate() or Scale() call and after a hold is in effect. More...
 
virtual void TransformHoldingFinish (TimeValue t)
 This method is called after the user has completed the Move(), Rotate() or Scale() operation and before the undo object has been accepted. More...
 
virtual void TransformFinish (TimeValue t)
 This method is called after the user has completed the Move(), Rotate() or Scale() operation and the undo object has been accepted. More...
 
virtual void TransformCancel (TimeValue t)
 This method is called when the transform operation is canceled by a right-click and the undo has been canceled. More...
 
virtual int HitTest (TimeValue t, INode *inode, int type, int crossing, int flags, IPoint2 *p, ViewExp *vpt, ModContext *mc)
 This method is used in modifier gizmo hit testing. More...
 
virtual int Display (TimeValue t, INode *inode, ViewExp *vpt, int flags, ModContext *mc)
 When this method is called the plug-in should respond by performing a quick render of the modifier gizmo in viewport using the current TM. More...
 
virtual void GetWorldBoundBox (TimeValue t, INode *inode, ViewExp *vpt, Box3 &box, ModContext *mc)
 This method computes the world space bounding box of the modifier gizmo (or any object that when in sub-object mode has a gizmo). More...
 
virtual void CloneSelSubComponents (TimeValue t)
 This method is called to make a copy of the selected sub-object components of the item. More...
 
virtual void AcceptCloneSelSubComponents (TimeValue t)
 This method is called when the user mouses up after shift-cloning a sub-object selection. More...
 
virtual void SelectSubComponent (HitRecord *hitRec, BOOL selected, BOOL all, BOOL invert=FALSE)
 This method is called to change the selection state of the component identified by hitRec. More...
 
virtual void ClearSelection (int selLevel)
 This method is called to clear the selection for the given sub-object level. More...
 
virtual void SelectAll (int selLevel)
 This method is called to select every element of the given sub-object level. More...
 
virtual void InvertSelection (int selLevel)
 This method is called to invert the specified sub-object level. More...
 
virtual int SubObjectIndex (HitRecord *hitRec)
 Returns the index of the sub-object element identified by the HitRecord hitRec. More...
 
virtual void ActivateSubobjSel (int level, XFormModes &modes)
 When the user changes the selection of the sub-object drop down, this method is called to notify the plug-in. More...
 
virtual BOOL SupportsNamedSubSels ()
 An object that supports sub-object selection can choose to support named sub object selection sets. More...
 
virtual void ActivateSubSelSet (MSTR &setName)
 When the user chooses a name from the drop down list this method is called. More...
 
virtual void NewSetFromCurSel (MSTR &setName)
 If the user types a new name into the named selection set drop down then this method is called. More...
 
virtual void RemoveSubSelSet (MSTR &setName)
 If the user selects a set from the drop down and then chooses Remove Named Selections from the Edit menu this method is called. More...
 
virtual void SetupNamedSelDropDown ()
 To support the Edit Named Selections dialog, plug-ins must implement this method. More...
 
virtual int NumNamedSelSets ()
 To support the Edit Named Selections dialog, plug-ins must implement this method. More...
 
virtual MSTR GetNamedSelSetName (int i)
 To support the Edit Named Selections dialog, plug-ins must implement this method. More...
 
virtual void SetNamedSelSetName (int i, MSTR &newName)
 To support the Edit Named Selections dialog, plug-ins must implement this method. More...
 
virtual void NewSetByOperator (MSTR &newName, Tab< int > &sets, int op)
 To support the Edit Named Selections dialog, plug-ins must implement this method. More...
 
virtual void GetSubObjectCenters (SubObjAxisCallback *cb, TimeValue t, INode *node, ModContext *mc)
 When the user is in a sub-object selection level, the system needs to get the reference coordinate system definition from the current modifier being edited so that it can display the axis. More...
 
virtual void GetSubObjectTMs (SubObjAxisCallback *cb, TimeValue t, INode *node, ModContext *mc)
 When the user is in a sub-object selection level, the system needs to get the reference coordinate system definition from the current modifier being edited so that it can display the axis. More...
 
virtual void NotifyPreCollapse (INode *node, IDerivedObject *derObj, int index)
 This method is called before a modifier or object is collapsed. More...
 
virtual void NotifyPostCollapse (INode *node, Object *obj, IDerivedObject *derObj, int index)
 This method is called after a modifier or object is collapsed. More...
 
virtual int NumSubObjTypes ()
 Objects and modifiers that support subobjects have to overwrite this method - as well as GetSubObjType() - and return a class derived from ISubObjType in GetSubObjType(). More...
 
virtual ISubObjTypeGetSubObjType (int i)
 Returns a pointer to the sub-object type for the sub-object whose index is passed. More...
 
virtual CoreExport int GetSubObjectLevel ()
 This method returns an integer which indicates the current sub-object level of the modifier or base object. More...
 
virtual BOOL HasUVW ()
 Call this method to find out if the object has UVW coordinates. More...
 
virtual BOOL HasUVW (int mapChannel)
 Call this method to find out if the object is has UVW coordinates for the specified mapping channel. More...
 
virtual void SetGenUVW (BOOL sw)
 This method is called to change the state of its Generate UVW boolean. More...
 
virtual void SetGenUVW (int mapChannel, BOOL sw)
 This method is called to change the state of its Generate UVW boolean for the specified mapping channel. More...
 
virtual void ShowEndResultChanged (BOOL showEndResult)
 This method notifies the BaseObject that the end result display has been switched (the "Show End Result" button has been toggled). More...
 
- Public Member Functions inherited from ReferenceTarget
virtual CoreExport void GetClassName (MSTR &s)
 Retrieves the (localizable) name of the plugin class. More...
 
virtual BOOL IsRefTarget ()
 Checks if this is a ReferenceTarget. More...
 
CoreExport RefResult TestForLoop (const Interval &refInterval, RefMakerHandle hmaker)
 Tests for a cyclical reference. More...
 
CoreExport BOOL HasDependents ()
 Checks if a ReferenceTarget has references. More...
 
CoreExport BOOL HasRealDependents ()
 Checks if this has Real (Strong) Dependents. More...
 
void BeginDependencyTest ()
 Starts Dependency Test. More...
 
BOOL EndDependencyTest ()
 Ends Dependency Test. More...
 
virtual void RefAdded (RefMakerHandle rm)
 Called after a reference is made to a target. More...
 
virtual void RefAddedUndoRedo (RefMakerHandle rm)
 Called after a reference is made to a target because of undo or redo. More...
 
virtual void RefDeleted ()
 Called after a references to this is deleted. More...
 
virtual void RefDeletedUndoRedo ()
 Called after a references to this is deleted because of undo or redo. More...
 
CoreExport RefResult DeleteAllRefsToMe ()
 Deletes all references to this ReferenceTarget. More...
 
CoreExport RefResult TransferReferences (RefTargetHandle oldTarget, BOOL delOld=FALSE)
 Transfers all the references from oldTarget to this. More...
 
CoreExport int DoEnumDependents (DependentEnumProc *dep)
 Begins an enumeration that searches back in the dependency network. More...
 
virtual CoreExport RefTargetHandle Clone (RemapDir &remap)
 This method is used by 3ds Max to clone an object. More...
 
virtual CoreExport void BaseClone (ReferenceTarget *from, ReferenceTarget *to, RemapDir &remap)
 This method copies base class data from an object to its clone. More...
 
virtual CoreExport RefResult NotifyDependents (const Interval &changeInt, PartID partID, RefMessage message, SClass_ID sclass=NOTIFY_ALL, BOOL propagate=TRUE, RefTargetHandle hTarg=NULL, NotifyDependentsOption notifyDependentsOption=REFNOTIFY_ALLOW_OPTIMIZATIONS)
 Notify all dependent RefMakers concerned with the message. More...
 
void FlagDependents (TimeValue t, PartID which=PART_PUT_IN_FG)
 This sends the REFMSG_FLAGDEPENDENTS message up the pipeline. More...
 
virtual void NotifyForeground (TimeValue t)
 This method is called to flag dependents into the FG. More...
 
virtual void NotifyTarget (int message, ReferenceMaker *hMaker)
 Sends messages to ReferenceTargets. More...
 
CoreExport ReferenceTarget ()
 Constructor. More...
 
virtual CoreExport RefResult AutoDelete ()
 Deletes the object when it has no more real dependents. More...
 
CoreExport RefResult MaybeAutoDelete ()
 Deletes the object when it has no more real dependents. More...
 
- Public Member Functions inherited from ReferenceMaker
CoreExport RefResult ReplaceReference (int which, RefTargetHandle newtarg, BOOL delOld=TRUE)
 Used when cloning reference makers. More...
 
CoreExport RefResult DeleteAllRefsFromMe ()
 Deletes all references from this ReferenceMaker. More...
 
CoreExport RefResult DeleteAllRefs ()
 Deletes all references both to and from this item. More...
 
CoreExport RefResult DeleteReference (int i)
 Deletes the specified reference. More...
 
virtual BOOL CanTransferReference (int i)
 Tells whether this reference can be transfered. More...
 
CoreExport ReferenceSaveManagerGetReferenceSaveManager ()
 Access the ReferenceSaveManager of this ReferenceMaker. More...
 
virtual int RemapRefOnLoad (int iref)
 Used to load old files with references. More...
 
virtual CoreExport void RescaleWorldUnits (float f)
 Rescale size of all world units in reference hierarchy. More...
 
virtual CoreExport void EnumAuxFiles (AssetEnumCallback &assetEnum, DWORD flags)
 Enumerate auxiliary files (e.g. bitmaps) More...
 
virtual CoreExport void SaveEnum (SaveEnumProc &sep, BOOL isNodeCall=0)
 The default save enumeration. More...
 
virtual CoreExport bool SpecifySaveReferences (ReferenceSaveManager &referenceSaveManager)
 Used to specify reference slot remapping during scene file save. More...
 
CoreExport int DoEnumDependents (DependentEnumProc *dep)
 Begins an enumeration that searches back in the dependency network. More...
 
CoreExport bool EnumRefHierarchy (RefEnumProc &proc, bool includeCustAttribs=true, bool includeIndirectRefs=true, bool includeNonPersistentRefs=true, bool preventDuplicatesViaFlag=true)
 This method provides a general purpose reference enumerator. More...
 
CoreExport int FindRef (RefTargetHandle rtarg)
 Get the index of the ReferenceTarget. More...
 
virtual BOOL IsRefMaker ()
 Tells whether it is a ReferenceMaker. More...
 
virtual BOOL IsRealDependency (ReferenceTarget *rtarg)
 Returns whether this is a "real" (strong) dependency or not. More...
 
virtual BOOL ShouldPersistWeakRef (RefTargetHandle rtarg)
 Specifies whether a weak reference is to be persisted on a partial load or save. More...
 
CoreExport ReferenceMaker ()
 Constructor. More...
 
CoreExport void DeleteMe ()
 Deletes an instance of this class. More...
 
virtual CoreExport int NumRefs ()
 Returns the total number of references this ReferenceMaker can hold. More...
 
virtual CoreExport RefTargetHandle GetReference (int i)
 Returns the 'i-th' reference. More...
 
- Public Member Functions inherited from Animatable
virtual void FreeCaches ()
 
virtual int NumChildren ()
 
virtual AnimatableChildAnim (int i)
 
virtual CoreExport MSTR NodeName ()
 
virtual void EditTrack ()
 
virtual CoreExport BOOL SubAnimSetKeyBufferPresent (int subNum)
 returns true if the sub-anim has a "Set Key" buffer present More...
 
virtual BOOL SetKeyBufferPresent ()
 returns true if there is a "Set Key" buffer present More...
 
virtual CoreExport void SubAnimCommitSetKeyBuffer (TimeValue t, int subNum)
 Commit any "Set Key" buffers on the given sub-anim. More...
 
virtual void CommitSetKeyBuffer (TimeValue t)
 Commit any "Set Key" buffers. More...
 
virtual CoreExport void SubAnimRevertSetKeyBuffer (int subNum)
 Revert any "Set Key" buffers on the given sub-anim. More...
 
virtual void RevertSetKeyBuffer ()
 Revert any "Set Key" buffers. More...
 
virtual LRESULT CALLBACK TrackViewWinProc (HWND hwnd, UINT message, WPARAM wParam, LPARAM lParam)
 This function is obsolete. More...
 
virtual bool IsParamBlockDesc2Used (ParamBlockDesc2 *desc)
 Returns true if the passed description is being used. More...
 
virtual bool GetMacroRecorderName (bool used_as_rhs_value, MSTR &objectSpecifiedName)
 This method is called to access the object specified name to use for the Maxscript macrorecorder. More...
 
CoreExport Animatable ()
 Constructor. More...
 
virtual CoreExport void DeleteThis ()
 Deletes an instance of this class. More...
 
MSTR ClassName () const
 Returns the name of the plugin class. More...
 
virtual CoreExport Class_ID ClassID ()
 Retrieves a constant that uniquely identifies the plugin class. More...
 
virtual void BeginEditParams (IObjParam *ip, ULONG flags, Animatable *prev=NULL)
 
virtual void EndEditParams (IObjParam *ip, ULONG flags, Animatable *next=NULL)
 
virtual CoreExport void ReleaseInterface (ULONG id, void *i)
 
virtual CoreExport int SetProperty (ULONG id, void *data)
 
virtual CoreExport voidGetProperty (ULONG id)
 
CoreExport void AppendProperty (AnimProperty *prop)
 A function to directly add arbitrary properties to this object developers should ensure that the properties ID does not conflict with any Max-specific IDs. More...
 
CoreExport AnimPropertyFindProperty (DWORD id)
 Find any property. More...
 
CoreExport void AddAppDataChunk (const Class_ID &cid, SClass_ID sid, DWORD sbid, DWORD len, void *data)
 Adds application/plugin specific (custom) data to an Animatable. More...
 
CoreExport AppDataChunkGetAppDataChunk (const Class_ID &cid, SClass_ID sid, DWORD sbid)
 Retrieves the application/plugin specific (custom) data stored with an Animatable. More...
 
CoreExport BOOL RemoveAppDataChunk (const Class_ID &cid, SClass_ID sid, DWORD sbid)
 Deletes the application/plugin specific (custom) data stored with an Animatable. More...
 
CoreExport void ClearAllAppData ()
 Deletes all application/plugin specific (custom) data stored with an Animatable. More...
 
virtual int NumSubs ()
 
virtual AnimatableSubAnim (int i)
 
virtual CoreExport MSTR SubAnimName (int i)
 
virtual BOOL CanDeleteSubAnim (int i)
 
virtual void DeleteSubAnim (int i)
 
virtual DWORD GetSubAnimCurveColor (int subNum)
 
virtual int SubNumToRefNum (int subNum)
 
virtual BOOL CanCopyAnim ()
 
CoreExport int HasSubElements (int type=0)
 
virtual int GetSubFCurveExtents (int subNum, ParamDimensionBase *dim, float &min, float &max, DWORD flags)
 The values max and min should be initialized before calling this function. More...
 
virtual ParamDimensionGetParamDimension (int i)
 
virtual BOOL SelectSubAnim (int subNum)
 
virtual BOOL BypassTreeView ()
 
virtual BOOL BypassTrackBar ()
 
virtual BOOL BypassPropertyLevel ()
 
virtual BOOL InvisibleProperty ()
 
virtual int NumKeys ()
 
virtual TimeValue GetKeyTime (int index)
 
virtual int GetKeyIndex (TimeValue t)
 
virtual BOOL GetNextKeyTime (TimeValue t, DWORD flags, TimeValue &nt)
 
virtual void CopyKeysFromTime (TimeValue src, TimeValue dst, DWORD flags)
 
virtual void DeleteKeyAtTime (TimeValue t)
 
virtual BOOL IsKeyAtTime (TimeValue t, DWORD flags)
 
virtual int GetKeyTimes (Tab< TimeValue > &times, Interval range, DWORD flags)
 
virtual int GetKeySelState (BitArray &sel, Interval range, DWORD flags)
 
CoreExport void OpenTreeEntry (int type, DWORD tv)
 
CoreExport void CloseTreeEntry (int type, DWORD tv)
 
CoreExport int IsTreeEntryOpen (int type, DWORD tv)
 
CoreExport BOOL GetSelInTrackView (DWORD tv)
 
CoreExport void SetSelInTrackView (DWORD tv, BOOL sel)
 
CoreExport BOOL InTrackViewSelSet (int which)
 
CoreExport void SetTrackViewSelSet (int which, BOOL inOut)
 
virtual BOOL AssignController (Animatable *control, int subAnim)
 
virtual BOOL CanAssignController (int subAnim)
 Return true if we can reassign the subanim specified. More...
 
virtual BOOL CanMakeUnique ()
 
CoreExport int EnumAnimTree (AnimEnum *animEnum, Animatable *client, int subNum)
 
virtual int RenderBegin (TimeValue t, ULONG flags=0)
 
virtual int RenderEnd (TimeValue t)
 
virtual CoreExport Interval GetTimeRange (DWORD flags)
 
virtual void EditTimeRange (Interval range, DWORD flags)
 
virtual void DeleteTime (Interval iv, DWORD flags)
 
virtual void ReverseTime (Interval iv, DWORD flags)
 
virtual void ScaleTime (Interval iv, float s)
 
virtual void InsertTime (TimeValue ins, TimeValue amount)
 
virtual BOOL SupportTimeOperations ()
 
virtual CoreExport void MapKeys (TimeMap *map, DWORD flags)
 
virtual void DeleteKeys (DWORD flags)
 
virtual void DeleteKeyByIndex (int index)
 
virtual void SelectKeys (TrackHitTab &sel, DWORD flags)
 
virtual void SelectSubKeys (int subNum, TrackHitTab &sel, DWORD flags)
 
virtual void SelectSubCurve (int subNum, BOOL sel)
 
virtual void SelectKeyByIndex (int i, BOOL sel)
 
virtual BOOL IsKeySelected (int i)
 
virtual void FlagKey (TrackHitRecord hit)
 
virtual int GetFlagKeyIndex ()
 
virtual int NumSelKeys ()
 
virtual void CloneSelectedKeys (BOOL offset=FALSE)
 
virtual void AddNewKey (TimeValue t, DWORD flags)
 
virtual void MoveKeys (ParamDimensionBase *dim, float delta, DWORD flags)
 
virtual void ScaleKeyValues (ParamDimensionBase *dim, float origin, float scale, DWORD flags)
 
virtual void SelectCurve (BOOL sel)
 
virtual BOOL IsCurveSelected ()
 Returns TRUE if the function curve is selected; otherwise returns FALSE. More...
 
virtual BOOL IsSubCurveSelected (int subNum)
 Returns the selected state of the sub-curve whose index is passed. More...
 
virtual int GetSelKeyCoords (TimeValue &t, float &val, DWORD flags)
 
virtual void SetSelKeyCoords (TimeValue t, float val, DWORD flags)
 
virtual int SetSelKeyCoordsExpr (ParamDimension *dim, const MCHAR *timeExpr, const MCHAR *valExpr, DWORD flags)
 
virtual void AdjustTangents (TrackHitRecord hit, ParamDimensionBase *dim, Rect &rcGraph, float tzoom, int tscroll, float vzoom, int vscroll, int dx, int dy, DWORD flags)
 
virtual void AdjustTangents (TrackHitRecord hit, ParamDimensionBase *dim, float angle, float length, DWORD flags)
 
virtual CoreExport BOOL IsAnimated ()
 
virtual BOOL CanCopyTrack (Interval iv, DWORD flags)
 
virtual BOOL CanPasteTrack (TrackClipObject *cobj, Interval iv, DWORD flags)
 
virtual TrackClipObjectCopyTrack (Interval iv, DWORD flags)
 
virtual void PasteTrack (TrackClipObject *cobj, Interval iv, DWORD flags)
 
virtual BOOL CanCopySubTrack (int subNum, Interval iv, DWORD flags)
 
virtual BOOL CanPasteSubTrack (int subNum, TrackClipObject *cobj, Interval iv, DWORD flags)
 
virtual TrackClipObjectCopySubTrack (int subNum, Interval iv, DWORD flags)
 
virtual void PasteSubTrack (int subNum, TrackClipObject *cobj, Interval iv, DWORD flags)
 
virtual int GetTrackVSpace (int lineHeight)
 
virtual int HitTestTrack (TrackHitTab &hits, Rect &rcHit, Rect &rcTrack, float zoom, int scroll, DWORD flags)
 
virtual int PaintTrack (ParamDimensionBase *dim, HDC hdc, Rect &rcTrack, Rect &rcPaint, float zoom, int scroll, DWORD flags)
 
virtual int PaintSubTrack (int subNum, ParamDimensionBase *dim, HDC hdc, Rect &rcTrack, Rect &rcPaint, float zoom, int scroll, DWORD flags)
 
virtual int PaintFCurves (ParamDimensionBase *dim, HDC hdc, Rect &rcGraph, Rect &rcPaint, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)
 
virtual int HitTestFCurves (ParamDimensionBase *dim, TrackHitTab &hits, Rect &rcHit, Rect &rcGraph, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)
 
virtual int PaintSubFCurves (int subNum, ParamDimensionBase *dim, HDC hdc, Rect &rcGraph, Rect &rcPaint, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)
 
virtual int HitTestSubFCurves (int subNum, ParamDimensionBase *dim, TrackHitTab &hits, Rect &rcHit, Rect &rcGraph, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)
 
virtual void EditTrackParams (TimeValue t, ParamDimensionBase *dim, const MCHAR *pname, HWND hParent, IObjParam *ip, DWORD flags)
 
virtual int TrackParamsType ()
 
virtual int GetFCurveExtents (ParamDimensionBase *dim, float &min, float &max, DWORD flags)
 This method is called to calculate the largest and smallest values of the anim. More...
 
CoreExport void AddNoteTrack (NoteTrack *note)
 
CoreExport void DeleteNoteTrack (NoteTrack *note, BOOL delNote=TRUE)
 
CoreExport BOOL HasNoteTracks ()
 
CoreExport int NumNoteTracks ()
 
CoreExport NoteTrackGetNoteTrack (int i)
 
virtual void FreeAllBitmaps ()
 
virtual void GetSystemNodes (INodeTab &nodes, SysNodeContext Context)
 
virtual BOOL IsSubClassOf (Class_ID classID)
 returns true if the animatable has sub-classed off the given class More...
 
virtual CoreExport void MouseCycleCompleted (TimeValue t)
 
virtual CoreExport void MouseCycleStarted (TimeValue t)
 
virtual int NumParamBlocks ()
 
virtual IParamBlock2GetParamBlock (int i)
 
virtual IParamBlock2GetParamBlockByID (short id)
 
CoreExport bool SvSaveData (ISave *isave, USHORT id)
 
CoreExport bool SvLoadData (ILoad *iLoad)
 
CoreExport DWORD SvGetRefIndex ()
 
CoreExport void SvSetRefIndex (DWORD i)
 
CoreExport bool SvDeleteRefIndex ()
 
CoreExport SvGraphNodeReference SvStdTraverseAnimGraph (IGraphObjectManager *gom, Animatable *owner, int id, DWORD flags)
 
virtual CoreExport bool SvIsHighlighted (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport COLORREF SvGetSwatchColor (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport bool SvIsInactive (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport bool SvEditProperties (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport MSTR SvGetTip (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport MSTR SvGetRefTip (IGraphObjectManager *gom, IGraphNode *gNode, IGraphNode *gNodeMaker)
 
virtual CoreExport bool SvCanDetach (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport bool SvDetach (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport MSTR SvGetRelTip (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
 Returns a string to be displayed in the tip window in the schematic view for a relationship from "gNodeMaker" to "gNodeTarget"... More...
 
virtual CoreExport bool SvCanDetachRel (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
 Returns true if this object can respond to the SvDetachRel(...) method... More...
 
virtual CoreExport bool SvDetachRel (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
 Detach this relationship. More...
 
virtual CoreExport bool SvHandleRelDoubleClick (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
 Called when this relationship is double-clicked in the schematic view... More...
 
CoreExport ICustAttribContainerGetCustAttribContainer ()
 This method returns a pointer to the custom attributes container interface class. More...
 
CoreExport void AllocCustAttribContainer ()
 This method allocates space for a custom attributes container. More...
 
CoreExport void DeleteCustAttribContainer ()
 This method deletes space used by a custom attributes container. More...
 
void SetAFlag (DWORD mask)
 
void ClearAFlag (DWORD mask)
 Clears one or more bits in the Animatable flags. More...
 
bool TestAFlag (DWORD mask) const
 Tests one or more bits in the Animatable flags. More...
 
void SetAFlagEx (DWORD mask)
 Sets one or more bits in the Animatable extended flags. More...
 
void ClearAFlagEx (DWORD mask)
 Clears one or more bits in the Animatable extended flags. More...
 
bool TestAFlagEx (DWORD mask) const
 Tests one or more bits in the Animatable extended flags. More...
 
CoreExport bool TestFlagBit (int index)
 Tests the specified flag bit. More...
 
CoreExport void SetFlagBit (int index, bool newValue=true)
 Sets the specified flag bit. More...
 
CoreExport void ClearFlagBit (int index)
 Clears the specified flag bit. More...
 
- Public Member Functions inherited from InterfaceServer
virtual UtilExport ~InterfaceServer ()
 Destructor. More...
 
- Public Member Functions inherited from FPMixinInterface
 FPMixinInterface ()
 
virtual LifetimeType LifetimeControl ()
 
virtual CoreExport bool RegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
virtual void UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
CoreExport ~FPMixinInterface ()
 
virtual BaseInterfaceGetInterface (Interface_ID id)
 
virtual FPInterfaceDescGetDescByID (Interface_ID id)
 
virtual Interface_ID GetID ()
 
- Public Member Functions inherited from FPInterface
virtual CoreExport FPStatus Invoke (FunctionID fid, TimeValue t=0, FPParams *params=NULL)
 
virtual FPStatus Invoke (FunctionID fid, FPParams *params)
 
virtual CoreExport FPStatus Invoke (FunctionID fid, TimeValue t, FPValue &result, FPParams *params=NULL)
 
virtual FPStatus Invoke (FunctionID fid, FPValue &result, FPParams *params=NULL)
 
virtual CoreExport FunctionID FindFn (const MCHAR *name)
 
virtual CoreExport BOOL IsEnabled (FunctionID actionID)
 
virtual CoreExport BOOL IsChecked (FunctionID actionID)
 
virtual CoreExport BOOL IsVisible (FunctionID actionID)
 
virtual CoreExport FunctionID GetIsEnabled (FunctionID actionID)
 
virtual CoreExport FunctionID GetIsChecked (FunctionID actionID)
 
virtual CoreExport FunctionID GetIsVisible (FunctionID actionID)
 
virtual ActionTableGetActionTable ()
 
virtual void EnableActions (BOOL onOff)
 
- Public Member Functions inherited from BaseInterface
virtual UtilExport ~BaseInterface ()
 Destructor. More...
 
virtual BaseInterfaceAcquireInterface ()
 
virtual void ReleaseInterface ()
 
virtual void DeleteInterface ()
 
virtual BaseInterfaceCloneInterface (void *remapDir=NULL)
 

Additional Inherited Members

- Public Types inherited from BaseInterface
enum  LifetimeType { noRelease, immediateRelease, wantsRelease, serverControlled }
 
- Static Public Member Functions inherited from Modifier
static CoreExport bool GetInputType (ClassDesc *cd, Class_ID &inputType)
 To determine the input type of a modifier, an instance of the modifier needs to be created. More...
 
- Static Public Member Functions inherited from Animatable
static CoreExport BOOL IsDeleted (Animatable *anim)
 Debug method to determine whether an object has been deleted. More...
 
static CoreExport AnimHandle GetHandleByAnim (Animatable *anim)
 Get the unique handle for an Animatable object. More...
 
static CoreExport AnimatableGetAnimByHandle (AnimHandle handle)
 Get an Animatable object from its unique handle. More...
 
static CoreExport void EnumerateAllAnimatables (EnumAnimList &enumProcObject)
 Enumerator to enumerate across all animatables. More...
 
static CoreExport bool RegisterAppDataLoadCallback (const Class_ID &cid, SClass_ID sid, APPDATALOADPROC proc)
 Registers a callback proc that is called when an AppDataChunk is read from a scene file. More...
 
static CoreExport bool UnRegisterAppDataLoadCallback (const Class_ID &cid, SClass_ID sid, APPDATALOADPROC proc)
 Unregisters a callback proc that is called when an AppDataChunk is read from a scene file. More...
 
static CoreExport bool RegisterAppDataLoadCallback (DWORD sbid, APPDATALOADPROC proc)
 Registers a callback proc that is called when an AppDataChunk is read from a scene file. More...
 
static CoreExport bool UnRegisterAppDataLoadCallback (DWORD sbid, APPDATALOADPROC proc)
 Unregisters a callback proc that is called when an AppDataChunk is read from a scene file. More...
 
static CoreExport int RequestFlagBit ()
 Requests an unique flag bit index. More...
 
static CoreExport void ReleaseFlagBit (int index)
 Releases the flag bit index. More...
 
static CoreExport void ClearFlagBitInAllAnimatables (int index)
 Clears the specified flag bit in all Animatables. More...
 
- 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 Public Attributes inherited from Animatable
static const AnimHandle kInvalidAnimHandle = 0
 
- Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc nullInterface
 
- Protected Member Functions inherited from ReferenceTarget
virtual CoreExport int DoEnumDependentsImpl (DependentEnumProc *dep)
 Method to perform an enumeration on a ReferenceTarget. More...
 
virtual CoreExport ~ReferenceTarget ()=0
 Destructor. More...
 
- Protected Member Functions inherited from ReferenceMaker
virtual RefResult NotifyRefChanged (const Interval &changeInt, RefTargetHandle hTarget, PartID &partID, RefMessage message, BOOL propagate)=0
 Receives and responds to messages. More...
 
virtual CoreExport ~ReferenceMaker ()=0
 Destructor. More...
 
virtual CoreExport void SetReference (int i, RefTargetHandle rtarg)
 Stores a ReferenceTarget as its 'i-th' reference`. More...
 
void BlockEval ()
 
void UnblockEval ()
 
int Evaluating ()
 
CoreExport RefResult StdNotifyRefChanged (const Interval &changeInt, RefTargetHandle hTarget, PartID partID, RefMessage message, BOOL propagate, NotifyDependentsOption notifyDependentsOption)
 
- Protected Member Functions inherited from Animatable
virtual CoreExport ~Animatable ()=0
 Destructor. More...
 
- Protected Member Functions inherited from Noncopyable
 Noncopyable ()
 
 ~Noncopyable ()
 
- Protected Member Functions inherited from FPMixinInterface
 FPMixinInterface (const FPMixinInterface &rhs)
 
FPMixinInterfaceoperator= (const FPMixinInterface &rhs)
 
- Protected Member Functions inherited from FPInterface
virtual FPStatus _dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)
 
- Protected Attributes inherited from BaseObject
MaxSDK::Graphics::RenderItemHandleArray mRenderItemHandles
 
- Protected Attributes inherited from Animatable
DWORD aflag
 
AnimPropertyList aprops
 
- Protected Attributes inherited from FPMixinInterface
Tab< InterfaceNotifyCallback * > * interfaceNotifyCBs
 

Member Function Documentation

VFN_0 ( unwrap_planarmap  ,
fnPlanarMap   
)
VFN_0 ( unwrap_save  ,
fnSave   
)
VFN_0 ( unwrap_load  ,
fnLoad   
)
VFN_0 ( unwrap_reset  ,
fnReset   
)
VFN_0 ( unwrap_edit  ,
fnEdit   
)
VFN_1 ( unwrap_setVC  ,
fnSetVC  ,
TYPE_BOOL   
)
FN_0 ( unwrap_getVC  ,
TYPE_BOOL  ,
fnGetVC   
)
VFN_0 ( unwrap_move  ,
fnMove   
)
VFN_0 ( unwrap_moveh  ,
fnMoveH   
)
VFN_0 ( unwrap_movev  ,
fnMoveV   
)
VFN_0 ( unwrap_rotate  ,
fnRotate   
)
VFN_0 ( unwrap_scale  ,
fnScale   
)
VFN_0 ( unwrap_scaleh  ,
fnScaleH   
)
VFN_0 ( unwrap_scalev  ,
fnScaleV   
)
VFN_0 ( unwrap_mirrorh  ,
fnMirrorH   
)
VFN_0 ( unwrap_mirrorv  ,
fnMirrorV   
)
VFN_0 ( unwrap_expandsel  ,
fnExpandSelection   
)
VFN_0 ( unwrap_weld  ,
fnWeld   
)
VFN_0 ( unwrap_weldselected  ,
fnWeldSelected   
)
VFN_0 ( unwrap_updatemap  ,
fnUpdatemap   
)
VFN_1 ( unwrap_displaymap  ,
fnDisplaymap  ,
TYPE_BOOL   
)
VFN_1 ( unwrap_setuvspace  ,
fnSetUVSpace  ,
TYPE_INT   
)
FN_0 ( unwrap_getuvspace  ,
TYPE_INT  ,
fnGetUVSpace   
)
VFN_0 ( unwrap_options  ,
fnOptions   
)
VFN_0 ( unwrap_lock  ,
fnLock   
)
VFN_0 ( unwrap_hide  ,
fnHide   
)
VFN_0 ( unwrap_unhide  ,
fnUnhide   
)
VFN_0 ( unwrap_freeze  ,
fnFreeze   
)
VFN_0 ( unwrap_thaw  ,
fnThaw   
)
VFN_0 ( unwrap_pan  ,
fnPan   
)
VFN_0 ( unwrap_zoom  ,
fnZoom   
)
VFN_0 ( unwrap_zoomregion  ,
fnZoomRegion   
)
VFN_0 ( unwrap_fit  ,
fnFit   
)
VFN_0 ( unwrap_fitselected  ,
fnFitSelected   
)
VFN_0 ( unwrap_snaptoggle  ,
fnSnapToggle   
)
FN_0 ( unwrap_numbermaps  ,
TYPE_INT  ,
fnNumberMaps   
)
FN_0 ( unwrap_getmatid  ,
TYPE_INT  ,
fnGetMatID   
)
VFN_1 ( unwrap_setmatid  ,
fnSetMatID  ,
TYPE_INT   
)
VFN_1 ( unwrap_movex  ,
fnMoveX  ,
TYPE_FLOAT   
)
VFN_1 ( unwrap_movey  ,
fnMoveY  ,
TYPE_FLOAT   
)
VFN_1 ( unwrap_movez  ,
fnMoveZ  ,
TYPE_FLOAT   
)
VFN_0 ( unwrap_fliph  ,
fnFlipH   
)
VFN_0 ( unwrap_flipv  ,
fnFlipV   
)
VFN_1 ( unwrap_forceupdate  ,
fnForceUpdate  ,
TYPE_BOOL   
)
VFN_1 ( unwrap_zoomtogizmo  ,
fnZoomToGizmo  ,
TYPE_BOOL   
)
VFN_1 ( unwrap_markasdead  ,
fnMarkAsDead  ,
TYPE_INT   
)
VFN_0 ( unwrap_updateview  ,
fnUpdateViews   
)
FPInterfaceDesc* GetDesc ( )
virtual
Remarks
Returns a pointer to the class which contains the interface metadata.

Implements FPInterface.

virtual void fnPlanarMap ( )
pure virtual
Remarks
This method will press the Planar Map button in the rollup interface.
virtual void fnSave ( )
pure virtual
Remarks
This method will press the Save button in the rollup interface.
virtual void fnLoad ( )
pure virtual
Remarks
This method will press the Load button in the rollup interface.
virtual void fnReset ( )
pure virtual
Remarks
This method will press the Reset button in the rollup interface.
virtual void fnEdit ( )
pure virtual
Remarks
This method will press the Edit button in the rollup interface.
virtual void fnSetMapChannel ( int  channel)
pure virtual
Remarks
This method will set the Map Channel field value in the rollup.
Parameters:
int channel

The Map Channel you want to set to.
virtual int fnGetMapChannel ( )
pure virtual
Remarks
This method will return the Map Channel field in the rollup.
virtual void fnSetProjectionType ( int  proj)
pure virtual
Remarks
This method will set the mapping type.
Parameters:
int proj

The mapping type; 1 for X aligned, 2 for Y aligned, 3 for Z aligned, 4 for normal aligned.
Returns
virtual int fnGetProjectionType ( )
pure virtual
Remarks
This method will return the mapping type; 1 for X aligned, 2 for Y aligned, 3 for Z aligned, 4 for normal aligned.
virtual void fnSetVC ( BOOL  vc)
pure virtual
Remarks
This method will set the Vertex Color Channel radio button in the rollup interface.
Parameters:
BOOL vc

TRUE to enable; FALSE to disable.

virtual BOOL fnGetVC ( )
pure virtual
Remarks
This method returns the current state of the Vertex Color Channel radio button in the rollup interface.
virtual void fnMove ( )
pure virtual
Remarks
This method will press the Move button in the edit floater.
virtual void fnMoveH ( )
pure virtual
Remarks
This method will press the Move Horizontal button in the edit floater.
virtual void fnMoveV ( )
pure virtual
Remarks
This method will press the Move Vertical button in the edit floater.
virtual void fnRotate ( )
pure virtual
Remarks
This method will press the Rotate button in the edit floater.
virtual void fnScale ( )
pure virtual
Remarks
This method will press the Scale button in the edit floater.
virtual void fnScaleH ( )
pure virtual
Remarks
This method will press the Scale Horizontal button in the edit floater.
virtual void fnScaleV ( )
pure virtual
Remarks
This method will press the Scale Vertical button in the edit floater.
virtual void fnMirrorH ( )
pure virtual
Remarks
This method will press the Mirror Horizontal button in the edit floater.
virtual void fnMirrorV ( )
pure virtual
Remarks
This method will press the Mirror Vertical button in the edit floater.
virtual void fnExpandSelection ( )
pure virtual
Remarks
This method will press the Expand Selection button in the edit floater.
virtual void fnContractSelection ( )
pure virtual
Remarks
This method will press the Contract Selection button in the edit floater.
virtual void fnSetFalloffType ( int  falloff)
pure virtual
Remarks
This method will set the Falloff type.
Parameters:
int falloff

The falloff type; 1 for linear, 2 for sinual, 3 for fast, and 4 for slow.
virtual int fnGetFalloffType ( )
pure virtual
Remarks
This method will return the falloff type; 1 for linear, 2 for sinual, 3 for fast, and 4 for slow.
virtual void fnSetFalloffSpace ( int  space)
pure virtual
Remarks
This method will set the space you want the falloff to be computed in.
Parameters:
int space

The falloff space; 1 for XY, the local space of the object, 2 for UV, the UVW space of the object.
virtual int fnGetFalloffSpace ( )
pure virtual
Remarks
This method will return the falloff space; 1 for XY, the local space of the object, 2 for UV, the UVW space of the object.
virtual void fnSetFalloffDist ( float  dist)
pure virtual
Remarks
This method will set the falloff distance in the edit floater.
Parameters:
float dist

The falloff distance.
virtual float fnGetFalloffDist ( )
pure virtual
Remarks
This method will return the falloff distance.
virtual void fnBreakSelected ( )
pure virtual
Remarks
This method will press the Break Selected button in the edit floater.
virtual void fnWeld ( )
pure virtual
Remarks
This method will press the Target Weld button in the edit floater.
virtual void fnWeldSelected ( )
pure virtual
Remarks
This method will press the Weld Selected button in the edit floater.
virtual void fnUpdatemap ( )
pure virtual
Remarks
This method will press the Update Map button in the edit floater.
virtual void fnDisplaymap ( BOOL  update)
pure virtual
Remarks
This method sets the state of the Display Map button in the edit floater
Parameters:
BOOL update

TRUE to toggle the Display Map button on; FALSE to toggle it off.
virtual BOOL fnIsMapDisplayed ( )
pure virtual
Remarks
This method returns the state of the Display Map button in the edit floater. TRUE if it's on; FALSE if it's off.
virtual void fnSetUVSpace ( int  space)
pure virtual
Remarks
This method sets the space that you want to view the texture vertices in.
Parameters:
int space

The texture space; 1 for UV, 2 for VW, 3 for UW.
virtual int fnGetUVSpace ( )
pure virtual
Remarks
This method returns the space that the texture vertices are viewed in; 1 for UV, 2 for VW, 3 for UW.
virtual void fnOptions ( )
pure virtual
Remarks
This method will press the Options button in the edit floater.
virtual void fnLock ( )
pure virtual
Remarks
This method will toggle the Lock Selected Vertices button in the edit floater.
virtual void fnHide ( )
pure virtual
Remarks
This method will press the Hide button in the edit floater.
virtual void fnUnhide ( )
pure virtual
Remarks
This method will press the Unhide button in the edit floater.
virtual void fnFreeze ( )
pure virtual
Remarks
This method will press the Freeze button in the edit floater.
virtual void fnThaw ( )
pure virtual
Remarks
This method will press the Unfreeze button in the edit floater.
virtual void fnFilterSelected ( )
pure virtual
Remarks
This method will press the Filter Selected Faces button in the edit floater.
virtual void fnPan ( )
pure virtual
Remarks
This method will press the Pan button in the edit floater.
virtual void fnZoom ( )
pure virtual
Remarks
This method will press the Zoom button in the edit floater.
virtual void fnZoomRegion ( )
pure virtual
Remarks
This method will press the Zoom Region button in the edit floater.
virtual void fnFit ( )
pure virtual
Remarks
This method will press the Fit button in the edit floater.
virtual void fnFitSelected ( )
pure virtual
Remarks
This method will press the Fit Selected button in the edit floater.
virtual void fnSnapToggle ( )
pure virtual
Remarks
This method will press the Snap button in the edit floater.
virtual int fnGetCurrentMap ( )
pure virtual
Remarks
This method returns the index into the map drop down list of the current map in the view of the edit floater.
virtual void fnSetCurrentMap ( int  map)
pure virtual
Remarks
This method sets the currently displayed map to the specified map index.
Parameters:
int map

The index of the map in the drop down list to display.
virtual int fnNumberMaps ( )
pure virtual
Remarks
This method returns the number of maps in the map drop down list.
virtual Point3* fnGetLineColor ( )
pure virtual
Remarks
This method returns the color of the lines used to connect the texture vertices edges as a Point3 pointer.
virtual void fnSetLineColor ( Point3  color)
pure virtual
Remarks
This method sets the line color of the texture vertices.
Parameters:
Point3 color

The color as a Point3.
virtual Point3* fnGetSelColor ( )
pure virtual
Remarks
This method returns the texture vertices selection color as Point3.
virtual void fnSetSelColor ( Point3  color)
pure virtual
Remarks
This method sets the color of selected texture vertices.
Parameters:
Point3 color

The color as a Point3.
virtual void fnSetRenderWidth ( int  dist)
pure virtual
Remarks
This method sets the width of the bitmap used to render to for display.
Parameters:
int dist

The width in pixels.
virtual int fnGetRenderWidth ( )
pure virtual
Remarks
This method returns the width of the bitmap used to render 2d/3d textures to and if the Use Bitmap Resolution bitmaps is not set the width used to render bitmap.
virtual void fnSetRenderHeight ( int  dist)
pure virtual
Remarks
This method sets the width of the bitmap used to render to for display.
Parameters:
int dist

The height in pixels.
virtual int fnGetRenderHeight ( )
pure virtual
Remarks
This method returns the height of the bitmap used to render 2d/3d textures to and if the Use Bitmap Resolution bitmaps is not set the height used to render bitmap.
virtual void fnSetWeldThreshold ( float  dist)
pure virtual
Remarks
This method sets the threshold values for welds.
Parameters:
float dist

The welding threshold/
Returns
virtual float fnGetWeldThresold ( )
pure virtual
Remarks
This method returns the weld threshold.
virtual void fnSetUseBitmapRes ( BOOL  useBitmapRes)
pure virtual
Remarks
This method sets the state of the Use Bitmap Resolution value. If it is false the bitmaps are rendered using the RenderWidth/Height values.
Parameters:
BOOL useBitmapRes

TRUE to toggle on; FALSE to toggle off.
virtual BOOL fnGetUseBitmapRes ( )
pure virtual
Remarks
This method returns the state of the Use Bitmap Resolution, if false the bitmaps are rendered using the RenderWidth/Height values.
virtual BOOL fnGetConstantUpdate ( )
pure virtual
Remarks
This method returns the state of the Constant Update value which when set true forces the veiwport to be updated on every move, otherwise it is just updated on mouse up.
virtual void fnSetConstantUpdate ( BOOL  constantUpdates)
pure virtual
Remarks
This method Sets the state of the Constant Update value which when set true forces the viewport to be updated on every move, otherwise it is just updated on mouse up.
Parameters:
BOOL constantUpdates

TRUE to toggle on; FALSE to toggle off.
virtual BOOL fnGetShowSelectedVertices ( )
pure virtual
Remarks
This method returns whether the selected texture vertices are also displayed in the view port.
virtual void fnSetShowSelectedVertices ( BOOL  show)
pure virtual
Remarks
This method sets whether the selected texture vertices are also displayed in the view port.
Parameters:
BOOL show

TRUE to toggle on; FALSE to toggle off.
virtual BOOL fnGetPixelCenterSnape ( )
pure virtual
Remarks
This method returns whether the mid pixels snap is used, if it is false the snap is set to the bottom right corner of the pixel, else it snaps to the center of the pixel.
virtual void fnSetPixelCenterSnape ( BOOL  midPixel)
pure virtual
Remarks
This method sets whether the mid pixels snap is used, if it is false the snap is set to the bottom right corner of the pixel, else it snaps to the center of the pixel.
Parameters:
BOOL midPixel

TRUE to toggle on; FALSE to toggle off.
virtual int fnGetMatID ( )
pure virtual
Remarks
This method returns the current material id index filter.
virtual void fnSetMatID ( int  matid)
pure virtual
Remarks
This method sets the material drop list to the index supplied.
Parameters:
int matid

The material ID index to set.
virtual int fnNumberMatIDs ( )
pure virtual
Remarks
This method returns the number of material ids in the material id filter drop down.
virtual BitArray* fnGetSelectedVerts ( )
pure virtual
Remarks
This method returns the current selected texture vertices in the edit floater as a bit array.
virtual void fnSelectVerts ( BitArray sel)
pure virtual
Remarks
This method selects texture vertices in the edit floater dialog.
Parameters:
BitArray *sel

The selection set as a bit array.
virtual BOOL fnIsVertexSelected ( int  index)
pure virtual
Remarks
This method returns whether a texture vertex is selected.
Parameters:
int index

The index of the vertex to check.
virtual void fnMoveSelectedVertices ( Point3  offset)
pure virtual
Remarks
This method moves the selected texture vertices by the offset.
Parameters:
Point3 offset

The offset by which you want to move the vertices.
virtual void fnRotateSelectedVertices ( float  angle)
pure virtual
Remarks
This method rotates the selected vertices around their center point.
Parameters:
float angle

The angle in radians that you want to rotate the selection by.
virtual void fnRotateSelectedVertices ( float  angle,
Point3  axis 
)
pure virtual
Remarks
This method rotates the selected vertices around a specified point.
Parameters:
float angle

The angle in radians that you want to rotate the selection by.

Point3 axis

The axis that you want to rotate the selected vertices by. This is in the space of the window.
virtual void fnScaleSelectedVertices ( float  scale,
int  dir 
)
pure virtual
Remarks
This method scales the selected points around their center.
Parameters:
float scale

The amount that you want to scale by

int dir

The direction; 1 for uniform scaling, 2 for X, and 3 for Y.
virtual void fnScaleSelectedVertices ( float  scale,
int  dir,
Point3  axis 
)
pure virtual
Remarks
This method scales the selected points around a specified point.
Parameters:
float scale

The amount that you want to scale by

int dir

The direction; 1 for uniform scaling, 2 for X, and 3 for Y.

Point3 axis

The axis that you want to scale the selected vertices by. This is in the space of the window.
virtual Point3* fnGetVertexPosition ( TimeValue  t,
int  index 
)
pure virtual
Remarks
This method returns the position of the vertex.
Parameters:
TimeValue t

The time at which you want to get the vertex.

int index

The index of the vertex.
virtual int fnNumberVertices ( )
pure virtual
Remarks
This method returns the number of texture vertices
virtual void fnMoveX ( float  p)
pure virtual
Remarks
This method sets the selected vertices x values in absolute coordinates.
Parameters:
float p

The absolute position along the x axis
Returns
virtual void fnMoveY ( float  p)
pure virtual
Remarks
This method sets the selected vertices y values in absolute coordinates.
Parameters:
float p

The absolute position along the y axis
virtual void fnMoveZ ( float  p)
pure virtual
Remarks
This method sets the selected vertices z values in absolute coordinates.
Parameters:
float p

The absolute position along the s axis
virtual BitArray* fnGetSelectedPolygons ( )
pure virtual
Remarks
This method returns the selected polygons in the view port as a bit array.
virtual void fnSelectPolygons ( BitArray sel)
pure virtual
Remarks
This method selects the polygons in the view ports.
Parameters:
BitArray *sel

The polygons you wish to select.
virtual BOOL fnIsPolygonSelected ( int  index)
pure virtual
Remarks
This method returns whether a polygon is selected or not.
Parameters:
int index

The index of the polygon to check.
Returns
virtual int fnNumberPolygons ( )
pure virtual
Remarks
This method returns the number of polygons in the object.
virtual void fnDetachEdgeVerts ( )
pure virtual
Remarks
This method detaches any vertex that is not completely surrounded by selected vertices. This is similar to a polygon selection detach except it uses the vertex selection to determine what is detached.
virtual void fnFlipH ( )
pure virtual
Remarks
This method will press the Flip Horizontal button in the edit floater.
virtual void fnFlipV ( )
pure virtual
Remarks
This method will press the Flip Vertical button in the edit floater.
virtual BOOL fnGetLockAspect ( )
pure virtual
Remarks
This method returns whether the edit window aspect ratio is locked or not, if the aspect ratio is not locked the image will try stretch to fit the aspect ratio of the window.
Returns
TRUE if locked; FALSE if unlocked.
virtual void fnSetLockAspect ( BOOL  a)
pure virtual
Remarks
This method sets the Lock Aspect Ratio value
Parameters:
BOOL a

TRUE to lock; FALSE to unlock.
virtual float fnGetMapScale ( )
pure virtual
Remarks
This method returns the scaling factor when the user applies a planar map. The smaller the value the more planar map is scaled down.
virtual void fnSetMapScale ( float  sc)
pure virtual
Remarks
This method sets the scaling factor when the user applies a planar map. The smaller the value the more planar map is scaled down
Parameters:
float sc

The scaling factor for planar map.
virtual void fnGetSelectionFromFace ( )
pure virtual
Remarks
This method takes the current polygon selection and uses it to select the texture vertices that are associated with it.
virtual void fnForceUpdate ( BOOL  update)
pure virtual
Remarks
This method sets a flag to determines how Unwrap will behave when a topology change occurs. If update is TRUE the mapping gets reset, otherwise unwrap skips mapping the object if it has a different topology. It is sometimes useful to turn this off if you have MeshSmooth or other topology changing modifiers below Unwrap that have different topologies when rendering.
Parameters:
BOOL update

This determines whether the mapping is reset on topology change. TRUE to update, otherwise FALSE.
virtual void fnZoomToGizmo ( BOOL  all)
pure virtual
Remarks
This method zooms the selected or all the viewports to zoom to the current planar map gizmo.
Parameters:
BOOL all

This determines whether the active or all the viewports get zoomed. TRUE to zoom all viewports, FALSE to view the active viewport.
virtual void fnSetVertexPosition ( TimeValue  t,
int  index,
Point3  pos 
)
pure virtual
Remarks
This method sets the position of a UVW vertex at a specific time.
Parameters:
TimeValue t

The time at what you want to set the position.

int index

The index of the vertex.

Point3 pos

The position of the vertex in UVW space.
virtual void fnMarkAsDead ( int  index)
pure virtual
Remarks
This method marks a vertex that it is dead, and no longer in use. Vertices are not actually deleted they are just marked and recycled when needed. That means when a vertex is added vertices marked as dead will be the first ones checked. If there are no dead vertices, the vertex is appended to the end of the list. Using this function carefully since marking a vertex as dead that is actually in use will cause strange results.
Parameters:
int vertex

The index of the vertex to mark as dead.
virtual int fnNumberPointsInFace ( int  index)
pure virtual
Remarks
This method retrieves the numbers of vertices that a face contains. A face can contain 3 to N number of points depending on what type of topology Unwrap is working on. For Tri Meshes this is always 3, for patches this can be 3 or 4, and for polygons this can be 3 or greater. Unwrap abstracts all three object types into one generic format.
Parameters:
int index

The index of the face to inspect.
virtual int fnGetVertexIndexFromFace ( int  index,
int  vertexIndex 
)
pure virtual
Remarks
This method retrieves the index of a vertex, from a face. A face contains 0 to N number of vertices. So to retrieve a particular vertex index, you give it the face index and the I-th vertex that you want to inspect. So if you wanted to look at the 3 vertex on face 1 you would call GetVertexIndexFromFace(1,3).
Parameters:
int index

The index of the face to inspect.

int vertexIndex

The I-th vertex of that you want to retrieve. This value should range from 1 to the number of vertices that the face contains.
Returns
virtual int fnGetHandleIndexFromFace ( int  index,
int  vertexIndex 
)
pure virtual
Remarks
This method retrieves the index of a handle, from a face. A face contains 0 to N number of handles. So to retrieve a particular handle index, you give it the face index and the I-th handle that you want to inspect. So if you wanted to look at the 3 handle on face 1 you would call GetHandleIndexFromFace(1,3). This only applies for patch meshes.
Parameters:
int index

The index of the face to inspect.

int vertexIndex

The I-th handle of that you want to retrieve. This value should range from 1 to the number of vertices*2 that the face contains.
virtual int fnGetInteriorIndexFromFace ( int  index,
int  vertexIndex 
)
pure virtual
Remarks
This method retrieves the index of a interior handle, from a face. A face contains 0 to N number of interior handles. So to retrieve a particular interior handle index, you give it the face index and the I-th interior handle that you want to inspect. So if you wanted to look at the 3 interior handle on face 1 you would call GetInteriorIndexFromFace(1,3). This only applies for patch meshes.
Parameters:
int index

The index of the face to inspect.

int vertexIndex

The I-th interior handle of that you want to retrieve. This value should range from 1 to the number of vertices that the face contains.
virtual int fnGetVertexGIndexFromFace ( int  index,
int  vertexIndex 
)
pure virtual
Remarks
This method retrieves the index of a geometric vertex, from a face. This the vertex that is attached to the mesh and not the texture faces. A face contains 0 to N number of vertices. So to retrieve a particular vertex index, you give it the face index and the I-th vertex that you want to inspect. So if you wanted to look at the 3 vertex on face 1 you would call GetVertexGeomIndexFromFace(1,3).
Parameters:
int index

The index of the face to inspect.

int vertexIndex

The I-th vertex of that you want to retrieve. This value should range from 1 to the number of vertices that the face contains.
virtual int fnGetHandleGIndexFromFace ( int  index,
int  vertexIndex 
)
pure virtual
Remarks
This method retrieves the index of a geometric handle from a patch. This the handle that is attached to the patch and not the texture faces. A face contains 0 to N number of handle. So to retrieve a particular handle index, you give it the face index and the I-th handle that you want to inspect. So if you wanted to look at the 3 handle on face 1 you would call GetHandleGeomIndexFromFace(1,3).
Parameters:
int index

The index of the face to inspect.

int vertexIndex

The I-th handle of that you want to retrieve. This value should range from 1 to the number of vertices*2 that the face contains.
virtual int fnGetInteriorGIndexFromFace ( int  index,
int  vertexIndex 
)
pure virtual
Remarks
This method retrieves the index of a geometric interior handle from a patch. This the interior handle that is attached to the patch and not the texture faces. A face contains 0 to N number of interior handle. So to retrieve a particular interior handle index, you give it the face index and the I-th interior handle that you want to inspect. So if you wanted to look at the 3 interior handle on face 1 you would call GetInteriorGeomIndexFromFace(1,3).
Parameters:
int index

The index of the face to inspect.

int vertexIndex

The I-th interior handle of that you want to retrieve. This value should range from 1 to the number of vertices that the face contains.
virtual void fnAddPoint ( Point3  pos,
int  fIndex,
int  ithV,
BOOL  sel 
)
pure virtual
Remarks
This method allows you to manipulate the position of vertex attached to a face. Basically it detaches the vertex if multiple faces share that vertex and then moves it to the position specified. So if you want to move the 3rd vertex of face 1 to .5,.5,.0 you would do setFaceVertex [.5 .5 .0] 1 3. If you don't want the vertex broken use SetVertexSPosition.
Parameters:
Point3 pos

The position that you want to move a vertex to.

int fIndex

The index of the face that you wish to work on.

int ithV

The ith vertex of the face that you want to change

BOOL sel

Whether or not to select the vertex after it is recreated
virtual void fnAddHandle ( Point3  pos,
int  fIndex,
int  ithV,
BOOL  sel 
)
pure virtual
Remarks
This method is identical to SetFaceVertex except works on patch handles.
Parameters:
Point3 pos

The position that you want to move a vertex to.

int fIndex

The index of the face that you wish to work on.

int ithV

The ith vertex of the face that you want to change

BOOL sel

Whether or not to select the vertex after it is recreated
virtual void fnAddInterior ( Point3  pos,
int  fIndex,
int  ithV,
BOOL  sel 
)
pure virtual
Remarks
This method is identical to SetFaceVertex except works on patch interior handles.
Parameters:
Point3 pos

The position that you want to move a vertex to.

int fIndex

The index of the face that you wish to work on.

int ithV

The ith vertex of the face that you want to change

BOOL sel

Whether or not to select the vertex after it is recreated
virtual void fnSetFaceVertexIndex ( int  fIndex,
int  ithV,
int  vIndex 
)
pure virtual
Remarks
This method allows you to set the index of the ith vertex of a face.
Parameters:
int fIndex

The index of the face that you wish to work on.

int ithV

The ith vertex of the face that you want to manipulate.

int vIndex

The index into the vertex list that you want to set to
virtual void fnSetFaceHandleIndex ( int  fIndex,
int  ithV,
int  vIndex 
)
pure virtual
Remarks
This method is identical to setFaceVertexIndex but works on handles for patches.
Parameters:
int fIndex

The index of the face that you wish to work on.

int ithV

The ith vertex of the face that you want to manipulate.

int vIndex

The index into the vertex list that you want to set to
virtual void fnSetFaceInteriorIndex ( int  fIndex,
int  ithV,
int  vIndex 
)
pure virtual
Remarks
This method is identical to setFaceVertexIndex but works on interior handles for patches.
Parameters:
int fIndex

The index of the face that you wish to work on.

int ithV

The ith vertex of the face that you want to manipulate.

int vIndex

The index into the vertex list that you want to set to

virtual void fnUpdateViews ( )
pure virtual
Remarks
This method forces the viewport and dialog to update.
virtual void fnGetFaceSelFromStack ( )
pure virtual
Remarks
This method looks at the current face selection in the stack, and copies it to the unwrap face selection. The reason this is useful is that if some one creates a new selection modifier Unwrap can use it. An example would be if you applied to Unwrap to a whole editable mesh , then you went back into the editable mesh, selected some faces by smoothing group, then turned off the face subobject selection. If you went back to Unwrap you could get this selection by calling getFaceSelectionFromStack.