IBaseGrip2 Class Reference

A virtual interface to extend IBaseGrip. More...

#include <igrip.h>

Inheritance diagram for IBaseGrip2:

Public Member Functions
virtual void	UpdateGripVisibility ()=0
	Based on different sub-object selection, the grip updates the controls in it to be visible or hidden.
virtual Interface_ID	GetID ()
	This method returns the unique interface ID for IBaseGrip2.
Public Member Functions inherited from IBaseGrip
virtual	~IBaseGrip ()
	Deconstructor.
virtual void	GetGripName (MSTR &string)=0
	Get the name of the grip.
virtual int	GetNumGripItems ()=0
	Get the number of grip items this grip contains.
virtual IBaseGrip::Type	GetType (int which)=0
	Get the type that the specified grip item will control.
virtual bool	GetText (int which, MSTR &string)=0
	Get the name of the specified grip item.
virtual bool	GetResolvedIconName (int which, MSTR &string)=0
	Get the file path of the icon that represents the specified grip item.
virtual DWORD	GetCustomization (int which)=0
	Get any special customization flags that this grip item needs to follow.
virtual bool	GetComboOptions (int which, Tab< ComboLabel * > &comboOptions)=0
	Get the option possibilities for this combo grip item.
virtual bool	GetCommandIcon (int which, MSTR &string)=0
	Get an icon for the IBaseGrip::eCommand grip item.
virtual bool	GetValue (int which, TimeValue t, IBaseGrip::GripValue &value)=0
	Get the value of the specified grip item.
virtual bool	ShowKeyBrackets (int which, TimeValue t)=0
	Whether or not key brackets, which will show in a spinner that a key is present, should be shown at the specified time.
virtual bool	GetRange (int which, IBaseGrip::GripValue &minRange, IBaseGrip::GripValue &maxRange)=0
	Get the range of this grip values.
virtual bool	GetResetValue (int which, IBaseGrip::GripValue &resetValue)=0
	Get the reset value of the grip.
virtual bool	ResetValue (TimeValue t, int which)=0
	Reset the specified grip.
virtual bool	SupportsOkayApplyCancel ()=0
	Whether or not, the Okay, Apply and Cancel grip buttons will get shown or not.
virtual void	Okay (TimeValue t)=0
	Accept any necessary changes and disable the grip to close the UI.
virtual void	Cancel ()=0
	Disregard and cancel any necessary changes and disable the grip to close the UI.
virtual void	Apply (TimeValue t)=0
	Accept any necessary changes and perform any pending action if needed.
virtual bool	SetValue (int which, TimeValue t, IBaseGrip::GripValue &value)=0
	Set the value of the specified.
virtual bool	StartSetValue (int which, TimeValue t)=0
	Get ready to set this value.
virtual bool	EndSetValue (int which, TimeValue t, bool accepted)=0
	The value is done setting values.
virtual bool	GetAutoScale (int which)=0
	Whether or nor we will use auto scaling when incrementing or decrementing this item.
virtual bool	GetScale (int which, IBaseGrip::GripValue &scaleValue)=0
	Get the scale value for this item when we increment or decrement it.
virtual bool	GetScaleInViewSpace (int which, float &depth)=0
	Get the scale value for this grip in view space, if one exists.
Public Member Functions inherited from BaseInterface
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)
Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor.
virtual UtilExport BaseInterface *	GetInterface (Interface_ID id)
template<class InterfaceType >
InterfaceType *	GetTypedInterface ()

Additional Inherited Members
Public Types inherited from IBaseGrip
enum	Type {   eInvalid = -1 , eInt = 0 , eFloat , eTime ,   eUniverse , eCombo , eToggle , eAction ,   eCommand , eStatus }
enum	Customization { eSameRow = 0x1 , eTurnOffLabel = 0x2 , eDisableAlt = 0x4 }
Public Types inherited from BaseInterface
enum	LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled }
Static Public Member Functions inherited from MaxHeapOperators
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.

Detailed Description

A virtual interface to extend IBaseGrip.

See also

class IBaseGrip

Member Function Documentation

UpdateGripVisibility()

virtual void UpdateGripVisibility ( )

pure virtual

Based on different sub-object selection, the grip updates the controls in it to be visible or hidden.

GetID()

virtual Interface_ID GetID ( )

inlinevirtual

This method returns the unique interface ID for IBaseGrip2.

Reimplemented from BaseInterface.

{ return IBASEGRIP2_INTERFACE; }