LightWrap++
AC++wrapperfortheLightWave3DSDK
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
lwpp::LWItemCallback Class Reference
LightWave 3D "entities"

Provide callback functions for LW Items in XPanels... More...

#include <item.h>

+ Inheritance diagram for lwpp::LWItemCallback:
+ Collaboration diagram for lwpp::LWItemCallback:

List of all members.

Public Member Functions

 LWItemCallback (LWItemType t=LWI_OBJECT, LWItemID id=LWITEM_NULL, bool _showNone=true, const char *_noneName="(none)")
 Constructor, default to an object and no object selected.
unsigned int AxisLocks (LWItemParam p)
void changeID (const LWItemID *id_array)
 Helper function.
LWChanGroupID ChanGroup (void)
void Controller (LWItemParam p, int type[3])
int * DataGet ()
 XPanels compatible DataGet.
void DataSet (void *value)
 XPanels compatible DataSet.
bool exists () const
 Checks if the light exists.
LWItem & First (LWItemType t)
LWItem & FirstChild (void)
unsigned int Flags (void)
ChannelGroup getChannelGroup (void)
int getExtension ()
LWItemID getFirstChild (void)
LWItemID GetID () const
int GetIndex ()
 return the index of object ID
LWItemID GetIndexID (int idx)
 return id of item number idx
const char * getName (void)
Matrix4x4d getObjectToWorld (LWTime time)
const char * GetSelectedName ()
const char * GetTag (int t)
Matrix4x4d getWorldTransform (LWTime time)
LWItem & Goal (void)
double GoalStrength (LWTime t)
bool isValid () const
 Checks if the LWItemInfo global is available or not.
unsigned int Limits (LWItemParam p, LWDVector min, LWDVector max)
virtual LWError Load (const LoadState &ls)
 Load on object, this will store the item ID in the end.
LWTime LookAhead (void)
LWItem & Next (void)
LWItem & NextChild (LWItem &parent)
bool operator! ()
 Check if the current item != LWITEM_NULL.
void Param (LWItemParam p, LWTime t, LWDVector v)
void Param (LWItemParam p, LWTime t, Vector3d &v)
void Param (LWItemParam p, LWTime t, Point3d &v)
LWItem Parent (void)
virtual LWError Save (const SaveState &ls)
 Save and object, using the name.
const char * Server (const char *s, int d)
unsigned int ServerFlags (const char *s, int d)
void SetID (LWItemID _id)
void SetTag (int t, const char *tag)
void Stiffness (LWItemParam p, LWDVector v)
LWItem & Target (void)
LWItem & ToParent (void)
void transformToWorld (Point3d &pt, LWTime time)
LWItemType Type (void)

Static Public Member Functions

static int PopCount (void *inst)
 PopCount callback for LightWave.
static const char * PopName (void *inst, int n)
 PopUpName name callback for LightWave.

Protected Member Functions

virtual size_t popCount (void)
 Return number of items.
virtual const char * popName (int idx)
 return name of item number idx

Protected Attributes

int index
std::string m_itemName
LWItemID mId
 ID of the stored object reference.
ItemInfo mItemInfo
LWItemType mType
const char * noneName
bool showNone

Detailed Description

Provide callback functions for LW Items in XPanels...

This class takes care of an item, including loading and saving item references

Todo:
turn this into a more universal wrapper, a managed variable/item or something like it...

Constructor & Destructor Documentation

lwpp::LWItemCallback::LWItemCallback ( LWItemType  t = LWI_OBJECT,
LWItemID  id = LWITEM_NULL,
bool  _showNone = true,
const char *  _noneName = "(none)" 
)
inline

Constructor, default to an object and no object selected.

Member Function Documentation

unsigned int lwpp::LWItem::AxisLocks ( LWItemParam  p)
inlineinherited
void lwpp::LWItem::changeID ( const LWItemID *  id_array)
inlineinherited

Helper function.

LWChanGroupID lwpp::LWItem::ChanGroup ( void  )
inlineinherited
void lwpp::LWItem::Controller ( LWItemParam  p,
int  type[3] 
)
inlineinherited
int* lwpp::LWItemCallback::DataGet ( )
inline

XPanels compatible DataGet.

void lwpp::LWItemCallback::DataSet ( void *  value)
inline

XPanels compatible DataSet.

bool lwpp::LWItem::exists ( void  ) const
inlineinherited

Checks if the light exists.

LWItem& lwpp::LWItem::First ( LWItemType  t)
inlineinherited
LWItem& lwpp::LWItem::FirstChild ( void  )
inlineinherited
unsigned int lwpp::LWItem::Flags ( void  )
inlineinherited
ChannelGroup lwpp::LWItem::getChannelGroup ( void  )
inlineinherited
int lwpp::LWItem::getExtension ( )
inherited
LWItemID lwpp::LWItem::getFirstChild ( void  )
inlineinherited
LWItemID lwpp::LWItem::GetID ( ) const
inlineinherited
int lwpp::LWItemCallback::GetIndex ( )
inline

return the index of object ID

LWItemID lwpp::LWItemCallback::GetIndexID ( int  idx)
inline

return id of item number idx

const char* lwpp::LWItem::getName ( void  )
inlineinherited
Matrix4x4d lwpp::LWItem::getObjectToWorld ( LWTime  time)
inherited
const char* lwpp::PopUpCallback::GetSelectedName ( )
inlineinherited
const char* lwpp::LWItem::GetTag ( int  t)
inlineinherited
Matrix4x4d lwpp::LWItem::getWorldTransform ( LWTime  time)
inherited
LWItem& lwpp::LWItem::Goal ( void  )
inlineinherited
double lwpp::LWItem::GoalStrength ( LWTime  t)
inlineinherited
bool lwpp::LWItem::isValid ( ) const
inlineinherited

Checks if the LWItemInfo global is available or not.

unsigned int lwpp::LWItem::Limits ( LWItemParam  p,
LWDVector  min,
LWDVector  max 
)
inlineinherited
LWError lwpp::LWItem::Load ( const LoadState &  ls)
virtualinherited

Load on object, this will store the item ID in the end.

Loading an item is safe in Modeler as well. In Layout, lwpp will first try to find an item with a matching name. If that fails it will use the id that was stored to reference the item.

In Modeler, lwpp will just store the item name and id and the use that for the next save.

  • Item name
  • Item ID
  • Item type

Reimplemented from lwpp::Storeable.

LWTime lwpp::LWItem::LookAhead ( void  )
inlineinherited
LWItem& lwpp::LWItem::Next ( void  )
inlineinherited
LWItem& lwpp::LWItem::NextChild ( LWItem &  parent)
inlineinherited
bool lwpp::LWItem::operator! ( )
inlineinherited

Check if the current item != LWITEM_NULL.

void lwpp::LWItem::Param ( LWItemParam  p,
LWTime  t,
LWDVector  v 
)
inlineinherited
void lwpp::LWItem::Param ( LWItemParam  p,
LWTime  t,
Vector3d &  v 
)
inlineinherited
void lwpp::LWItem::Param ( LWItemParam  p,
LWTime  t,
Point3d &  v 
)
inlineinherited
LWItem lwpp::LWItem::Parent ( void  )
inlineinherited
static int lwpp::PopUpCallback::PopCount ( void *  inst)
inlinestaticinherited

PopCount callback for LightWave.

virtual size_t lwpp::LWItemCallback::popCount ( void  )
inlineprotectedvirtual

Return number of items.

Implements lwpp::PopUpCallback.

Reimplemented in lwpp::StyledItemCallback.

static const char* lwpp::PopUpCallback::PopName ( void *  inst,
int  n 
)
inlinestaticinherited

PopUpName name callback for LightWave.

virtual const char* lwpp::LWItemCallback::popName ( int  idx)
inlineprotectedvirtual

return name of item number idx

Implements lwpp::PopUpCallback.

Reimplemented in lwpp::StyledItemCallback.

LWError lwpp::LWItem::Save ( const SaveState &  ls)
virtualinherited

Save and object, using the name.

  • Item name
  • ItemID
  • Item type

Reimplemented from lwpp::Storeable.

const char* lwpp::LWItem::Server ( const char *  s,
int  d 
)
inlineinherited
unsigned int lwpp::LWItem::ServerFlags ( const char *  s,
int  d 
)
inlineinherited
void lwpp::LWItem::SetID ( LWItemID  _id)
inlineinherited
void lwpp::LWItem::SetTag ( int  t,
const char *  tag 
)
inlineinherited
void lwpp::LWItem::Stiffness ( LWItemParam  p,
LWDVector  v 
)
inlineinherited
LWItem& lwpp::LWItem::Target ( void  )
inlineinherited
LWItem& lwpp::LWItem::ToParent ( void  )
inlineinherited
void lwpp::LWItem::transformToWorld ( Point3d &  pt,
LWTime  time 
)
inherited
LWItemType lwpp::LWItem::Type ( void  )
inlineinherited

Member Data Documentation

int lwpp::PopUpCallback::index
protectedinherited
std::string lwpp::LWItem::m_itemName
protectedinherited
LWItemID lwpp::LWItem::mId
protectedinherited

ID of the stored object reference.

ItemInfo lwpp::LWItem::mItemInfo
protectedinherited
LWItemType lwpp::LWItem::mType
protectedinherited
const char* lwpp::LWItemCallback::noneName
protected
bool lwpp::LWItemCallback::showNone
protected
The documentation for this class was generated from the following file: