3ds Max C++ API Reference
|
The interface to the functionality for using the Grip Manager. More...
#include <igrip.h>
Public Member Functions | |
virtual void | RecalcLayout ()=0 |
Function to recalculate the layout and position of all of the grip items. | |
Enable/Disable | |
virtual void | SetGripActive (IBaseGrip *grip)=0 |
Make the grip active and show it. | |
virtual void | SetGripsInactive ()=0 |
Inactivate the current active grip. | |
virtual IBaseGrip * | GetActiveGrip ()=0 |
Get the current active grip. | |
Grip Item | |
virtual bool | ActivateGripItem (int whichItem, bool active)=0 |
Set whether or not a particular grip item of the active grip will be activated or not. | |
virtual bool | IsGripItemActive (int whichItem)=0 |
Get whether or not a particular grip item of the active grip is active or not. | |
virtual bool | HideGripItem (int whichItem, bool hide)=0 |
Set whether or not a particular grip item of the active grip will be visible or not. | |
virtual bool | IsGripItemVisible (int whichItem)=0 |
Get whether or not a particular grip item of the active grip is visible or not. | |
ResetUI | |
virtual bool | ResetGripUI (int whichItem)=0 |
Tell that grip item it should reset its UI, usually since some value has changed and needs to get refleced in the UI. | |
virtual void | ResetAllUI ()=0 |
Convienence function to reset all of a grip's UI. | |
Show | |
virtual void | SetShow (bool val)=0 |
Show grips. | |
virtual bool | GetShow () const =0 |
Get if grips are shown. | |
Grip Placement | |
virtual void | GetXYLocation (float &x, float &y)=0 |
Get the location of the grip in screen space. | |
virtual void | SetLocation (int x, int y)=0 |
Set the location of the grip in screen space. | |
virtual void | SetCenterOnSelected (bool val)=0 |
Set whether or not the grip stays centered around the current selection gizmo. | |
virtual bool | GetCenterOnSelected () const =0 |
Get whether or not the grip stays centered around the current selection gizmo. | |
virtual void | SetCenterXYPos (float x, float y)=0 |
Set the normalized x and y location of the grip in the active viewport. | |
virtual float | GetCenterYPos () const =0 |
Get the normalized y location of the grip in the active viewport. | |
virtual float | GetCenterXPos () const =0 |
Get the normalized x location of the grip in the active viewport. | |
virtual void | SetSelectedOffsetXY (int offsetPixelX, int offsetPixelY)=0 |
Set the x and y pixel offset from the current selection gizmo where the grip will get placed. | |
virtual int | GetSelectedOffsetX () const =0 |
Get the x pixel offset from the current selection gizmo where the grip will get placed. | |
virtual int | GetSelectedOffsetY () const =0 |
Get the y pixel offset from the current selection gizmo where the grip will get placed. | |
Transparency | |
virtual void | SetTransparency (float val)=0 |
Set the transparency of the grip items in the viewport. | |
virtual float | GetTransparency () const =0 |
Get the transparency of the grip items in the viewport. | |
virtual void | SetHoverTransparency (float val)=0 |
Set the hover transparency of the grip items in the viewport. | |
virtual float | GetHoverTransparency () const =0 |
Get the hover transparency of the grip items in the viewport. | |
Widget Spacing | |
virtual void | SetWidgetSpacing (float spacing)=0 |
Set the spacing in pixels between the main grip UI elements. | |
virtual float | GetWidgetSpacing () const =0 |
Get the spacing in pixels between the main grip UI elements. | |
GripChangedCallback | |
virtual void | RegisterGripChangedCallback (GripChangedCallback *cB)=0 |
Register a callback that will get called when the active grip changes. | |
virtual void | UnRegisterGripChangedCallback (GripChangedCallback *cB)=0 |
Unregister the grip changed ballback. | |
![]() | |
CoreExport | FPInterfaceDesc () |
CoreExport | FPInterfaceDesc (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *cd, ULONG flag,...) |
CoreExport | ~FPInterfaceDesc () |
virtual void | Init () |
LifetimeType | LifetimeControl () |
virtual BaseInterface * | GetInterface (Interface_ID id) |
CoreExport void | LoadDescriptor (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *pCD, ULONG flag,...) |
CoreExport void | AppendFunction (int id,...) |
Add a new function to this interface descriptor. | |
CoreExport void | AppendProperty (int id,...) |
Add a new property to this interface descriptor. | |
CoreExport void | AppendEnum (int id,...) |
Add a new enum to this interface descriptor. | |
CoreExport void | SetClassDesc (ClassDesc *i_cd) |
CoreExport va_list | check_fn (va_list ap, int id) |
CoreExport va_list | scan_fn (va_list ap, int id, int index) |
CoreExport va_list | check_prop (va_list ap, int id) |
CoreExport va_list | scan_prop (va_list ap, int id, int index) |
CoreExport va_list | check_enum (va_list ap, EnumID id) |
CoreExport va_list | scan_enum (va_list ap, EnumID id, int index) |
FPInterfaceDesc * | GetDesc () |
Interface_ID | GetID () |
CoreExport FPFunctionDef * | GetFnDef (FunctionID fid) |
ActionTable * | GetActionTable () |
CoreExport void | EnableActions (BOOL onOff) |
virtual CoreExport HINSTANCE | HInstance () |
virtual CoreExport const MCHAR * | GetRsrcString (StringResID id) |
![]() | |
virtual BaseInterface * | GetInterface (Interface_ID id) |
virtual FPInterfaceDesc * | GetDesc ()=0 |
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 ActionTable * | GetActionTable () |
virtual void | EnableActions (BOOL onOff) |
![]() | |
virtual UtilExport | ~BaseInterface () |
Destructor. | |
UtilExport BaseInterface * | GetInterface (Interface_ID id) override |
virtual UtilExport Interface_ID | GetID () |
virtual LifetimeType | LifetimeControl () |
virtual bool | RegisterNotifyCallback (InterfaceNotifyCallback *incb) |
virtual void | UnRegisterNotifyCallback (InterfaceNotifyCallback *incb) |
virtual BaseInterface * | AcquireInterface () |
virtual void | ReleaseInterface () |
virtual void | DeleteInterface () |
virtual BaseInterface * | CloneInterface (void *remapDir=nullptr) |
![]() | |
virtual UtilExport | ~InterfaceServer () |
Destructor. | |
virtual UtilExport BaseInterface * | GetInterface (Interface_ID id) |
template<class InterfaceType > | |
InterfaceType * | GetTypedInterface () |
Additional Inherited Members | |
![]() | |
enum | LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled } |
![]() | |
static UtilExport void * | operator new (size_t size) |
Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. | |
static UtilExport void * | operator 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. | |
static UtilExport void * | operator 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. | |
static UtilExport void * | operator 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. | |
static UtilExport void * | operator 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. | |
static UtilExport void * | operator 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. | |
static UtilExport void * | operator 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. | |
static UtilExport void * | operator new[] (size_t size) |
New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. | |
static UtilExport void * | operator 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. | |
static UtilExport void * | operator 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. | |
static UtilExport void * | operator new[] (size_t size, int block_type, const char *filename, int line) |
New operator used to allocate arrays of objects. | |
static UtilExport void * | operator 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. | |
static UtilExport void * | operator 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. | |
static UtilExport void * | operator 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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
static UtilExport void * | operator new (size_t size, void *placement_ptr) |
Placement new operator. | |
static UtilExport void | operator delete (void *ptr, void *placement_ptr) |
Placement delete operator. | |
static UtilExport void * | aligned_malloc (size_t size, size_t alignment) |
Allocates memory on a specified alignment boundary. | |
static UtilExport void * | aligned_realloc (void *ptr, size_t size, size_t alignment) |
Reallocates memory on a specified alignment boundary. | |
static UtilExport void | aligned_free (void *ptr) |
Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. | |
![]() | |
Interface_ID | ID |
MSTR | internal_name |
StringResID | description |
ClassDesc * | cd |
USHORT | flags |
Tab< FPFunctionDef * > | functions |
Tab< FPPropDef * > | props |
Tab< FPEnum * > | enumerations |
MSPluginClass * | pc |
Rollout * | rollout |
ActionTable * | action_table |
![]() | |
static CoreExport FPInterfaceDesc | nullInterface |
![]() | |
CoreExport void | load_descriptor (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *cd, USHORT flag, va_list ap) |
![]() | |
virtual FPStatus | _dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p) |
The interface to the functionality for using the Grip Manager.
This class contains key functionality for using grips. It contains functionality for setting which grip is active in addition to various options for how grips are displayed and manipulated. You get this interface by calling GetIGripManager(). This class is created by the system.
Make the grip active and show it.
[in] | grip | The grip that will turn active and have its UI displayed. If another grip was active, that grip becomes inactive. Only one grip may be active at a time. If the value is NULL this functions acts like SetGripsInactive. |
|
pure virtual |
Inactivate the current active grip.
If no grip is active, nothing happens.
|
pure virtual |
Get the current active grip.
|
pure virtual |
Set whether or not a particular grip item of the active grip will be activated or not.
By default, all grip items are activated and interactive.
[in] | whichItem | The zero based index for the item for which we will be activate or not. If out of range of the number of grip items, on the active grip this function will do nothing. |
[in] | active | If true the item is active and can get manipulated, if false, the item is disabled and greyed out in the viewport. |
|
pure virtual |
Get whether or not a particular grip item of the active grip is active or not.
[in] | whichItem | The zero based index for the item for which we are checking to see if it's active or not. |
|
pure virtual |
Set whether or not a particular grip item of the active grip will be visible or not.
By default, all grip items are visible.
[in] | whichItem | The zero based index for the item for which we will display or hide. If out of range of the number of grip items, on the active grip this function will do nothing. |
[in] | hide | If true the item is hidden and is not displayed, if false, the item is displayed. Note that by default all grip items are visible. Note in order to see the change in the UI, you must call ResetAllGripUI(). |
|
pure virtual |
Get whether or not a particular grip item of the active grip is visible or not.
[in] | whichItem | The zero based index for the item for which we are checking to see if it's visible. |
|
pure virtual |
Tell that grip item it should reset its UI, usually since some value has changed and needs to get refleced in the UI.
When called that item will call the necessary IBaseGrip functions, such as GetValue, to reset and recreate the UI,
[in] | whichItem | The zero based index for the item for which needs to reset its UI. |
|
pure virtual |
|
pure virtual |
Show grips.
By default grips are shown when one is active.
[in] | val | If true grips will be shown, if false no grips will be shown even if active. |
|
pure virtual |
Get if grips are shown.
|
pure virtual |
Get the location of the grip in screen space.
[out] | x | The x location of the grip in screen space. |
[out] | y | The y location of the grip in screen space. |
Set the location of the grip in screen space.
[in] | x | The x location of the grip in screen space that you want the grip's upper right corner to be placed. |
[in] | y | The y location of the grip in screen space that you want the grip's upper right corner to be placed. |
|
pure virtual |
Set whether or not the grip stays centered around the current selection gizmo.
[in] | val | If true the grip stays centered around the current selection gizmo, if false the grip stays fixed at it's current viewport location. |
|
pure virtual |
Get whether or not the grip stays centered around the current selection gizmo.
return If true the grip stays centered around the current selection gizmo, if false the grip stays fixed at it's current viewport location.
|
pure virtual |
Set the normalized x and y location of the grip in the active viewport.
These values are used if GetCenterOnSelection returns false.
[in] | x | The normalized [0-1] x location of the grip in the active viewport. So a value of 0.5 will place the grip in the center of viewport. |
[in] | y | The normalized [0-1] y location of the grip in the active viewport. So a value of 0.5 will place the grip in the center of viewport. |
|
pure virtual |
Get the normalized y location of the grip in the active viewport.
These values are used if GetCenterOnSelection returns false.
|
pure virtual |
Get the normalized x location of the grip in the active viewport.
These values are used if GetCenterOnSelection returns false.
Set the x and y pixel offset from the current selection gizmo where the grip will get placed.
These values are used if GetCenterOnSelection returns true.
[in] | offsetPixelX | The x pixel offset off of the current selection where the grip will get placed. |
[in] | offsetPixelY | The y pixel offset off of the current selection where the grip will get placed. |
|
pure virtual |
Get the x pixel offset from the current selection gizmo where the grip will get placed.
These values are used if GetCenterOnSelection returns true.
|
pure virtual |
Get the y pixel offset from the current selection gizmo where the grip will get placed.
These values are used if GetCenterOnSelection returns true.
|
pure virtual |
Set the transparency of the grip items in the viewport.
[in] | val | The transparency of the grip items in the viewport. Range is from 0, opaque to 1, fully transparent. |
|
pure virtual |
Get the transparency of the grip items in the viewport.
|
pure virtual |
Set the hover transparency of the grip items in the viewport.
[in] | val | The transparency of the grip items in the viewport when the grip item has the mouse cursor over it. Range is from 0, opaque to 1, fully transparent. |
|
pure virtual |
Get the hover transparency of the grip items in the viewport.
|
pure virtual |
|
pure virtual |
|
pure virtual |
Register a callback that will get called when the active grip changes.
[in] | cB | - The callback that you are registering. If NULL this function does nothing. |
|
pure virtual |
Unregister the grip changed ballback.
[in] | cB | - The callback that you are unregistering. If NULL or the callback is not registered this function does nothing.\ |