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

#include <item.h>

+ Inheritance diagram for lwpp::LWItem:
+ Collaboration diagram for lwpp::LWItem:

List of all members.

Public Member Functions

 LWItem (LWItemID id=LWITEM_NULL, LWItemType t=LWI_OBJECT)
 Used only for storing the name when loading and saving in Modeler.
 LWItem (const LWItem &item)
 LWItem (const LWItemType t)
unsigned int AxisLocks (LWItemParam p)
void changeID (const LWItemID *id_array)
 Helper function.
LWChanGroupID ChanGroup (void)
void Controller (LWItemParam p, int type[3])
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
const char * getName (void)
Matrix4x4d getObjectToWorld (LWTime time)
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)

Protected Attributes

std::string m_itemName
LWItemID mId
 ID of the stored object reference.
ItemInfo mItemInfo
LWItemType mType

Constructor & Destructor Documentation

lwpp::LWItem::LWItem ( LWItemID  id = LWITEM_NULL,
LWItemType  t = LWI_OBJECT 
)
inlineexplicit

Used only for storing the name when loading and saving in Modeler.

lwpp::LWItem::LWItem ( const LWItem &  item)
inline
lwpp::LWItem::LWItem ( const LWItemType  t)
inline

Member Function Documentation

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

Helper function.

LWChanGroupID lwpp::LWItem::ChanGroup ( void  )
inline
void lwpp::LWItem::Controller ( LWItemParam  p,
int  type[3] 
)
inline
bool lwpp::LWItem::exists ( void  ) const
inline

Checks if the light exists.

LWItem& lwpp::LWItem::First ( LWItemType  t)
inline
LWItem& lwpp::LWItem::FirstChild ( void  )
inline
unsigned int lwpp::LWItem::Flags ( void  )
inline
ChannelGroup lwpp::LWItem::getChannelGroup ( void  )
inline
int lwpp::LWItem::getExtension ( )
LWItemID lwpp::LWItem::getFirstChild ( void  )
inline
LWItemID lwpp::LWItem::GetID ( ) const
inline
const char* lwpp::LWItem::getName ( void  )
inline
Matrix4x4d lwpp::LWItem::getObjectToWorld ( LWTime  time)
const char* lwpp::LWItem::GetTag ( int  t)
inline
Matrix4x4d lwpp::LWItem::getWorldTransform ( LWTime  time)
LWItem& lwpp::LWItem::Goal ( void  )
inline
double lwpp::LWItem::GoalStrength ( LWTime  t)
inline
bool lwpp::LWItem::isValid ( ) const
inline

Checks if the LWItemInfo global is available or not.

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

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  )
inline
LWItem& lwpp::LWItem::Next ( void  )
inline
LWItem& lwpp::LWItem::NextChild ( LWItem &  parent)
inline
bool lwpp::LWItem::operator! ( )
inline

Check if the current item != LWITEM_NULL.

void lwpp::LWItem::Param ( LWItemParam  p,
LWTime  t,
LWDVector  v 
)
inline
void lwpp::LWItem::Param ( LWItemParam  p,
LWTime  t,
Vector3d &  v 
)
inline
void lwpp::LWItem::Param ( LWItemParam  p,
LWTime  t,
Point3d &  v 
)
inline
LWItem lwpp::LWItem::Parent ( void  )
inline
LWError lwpp::LWItem::Save ( const SaveState &  ls)
virtual

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 
)
inline
unsigned int lwpp::LWItem::ServerFlags ( const char *  s,
int  d 
)
inline
void lwpp::LWItem::SetID ( LWItemID  _id)
inline
void lwpp::LWItem::SetTag ( int  t,
const char *  tag 
)
inline
void lwpp::LWItem::Stiffness ( LWItemParam  p,
LWDVector  v 
)
inline
LWItem& lwpp::LWItem::Target ( void  )
inline
LWItem& lwpp::LWItem::ToParent ( void  )
inline
void lwpp::LWItem::transformToWorld ( Point3d &  pt,
LWTime  time 
)
LWItemType lwpp::LWItem::Type ( void  )
inline

Member Data Documentation

std::string lwpp::LWItem::m_itemName
protected
LWItemID lwpp::LWItem::mId
protected

ID of the stored object reference.

ItemInfo lwpp::LWItem::mItemInfo
protected
LWItemType lwpp::LWItem::mType
protected
The documentation for this class was generated from the following files: