The Variant Parameter Class Wrapper. More...

#include <vparm.h>

Inheritance diagram for lwpp::VParm:

Collaboration diagram for lwpp::VParm:

Public Member Functions
	VParm (int type, const std::string name, std::string plug_name, LWChanGroupID group=0, double v=0.0)
	VParm (int type, const std::string name, std::string plug_name, LWChanGroupID group, Vector3d &v)
	VParm (int type, const std::string name, std::string plug_name, ChannelGroup &group, double v=0.0)
	VParm (int type, const std::string name, std::string plug_name, ChannelGroup &group, Vector3d &v)
virtual	~VParm ()
void	Abs ()
T *	asLWVector ()
void	Clear ()
Vector3	Cross (Vector3 a) const
T	Dot (Vector3 a) const
	Get the Dot product.
double	GetValue () const
float	GetValuef () const
LWVParmID	ID ()
	Return the LWVParmID for the current object.
bool	isEnveloped ()
virtual LWError	Load (const lwpp::LoadState &ls)
	Load a VParm from a LW scene/object.
T	Magnitude () const
	Return the Length/Magnitude of the Vector3.
void	NewTime (LWTime t)
	Update the current time value (which is cached for faster access)
Vector3 &	Normalize ()
	Normalize the Vector3.
Vector3	operator* (Vector3 b)
Vector3	operator* (double b)
Vector3 &	operator*= (Vector3 b)
Vector3 &	operator*= (T b)
Vector3	operator+ (Vector3 b)
	Add a Vector3.
Vector3 &	operator+= (Vector3 b)
Vector3	operator- (Vector3 b)
	Subtract a Vector3.
Vector3 &	operator-= (Vector3 b)
	Subtract a Vector3.
Vector3	operator/ (Vector3 b)
Vector3	operator/ (T b)
Vector3 &	operator/= (Vector3 b)
Vector3 &	operator/= (T b)
VParm &	operator= (const VParm &from)
	Copy values.
void	Reset (const double d)
void	Reset (const Vector3d &v)
virtual LWError	Save (const lwpp::SaveState &ss)
	Save a VParm to a LW scene/object.
void	Set (const double d)
	Set the current time Value to a new Value.
void	Set (const Vector3d &v)
void	Set (const LWDVector v)
void	Set (const LWFVector v)
T	SphericalPhi ()
T	SphericalTheta ()
void	Translate (Vector3 dir, T distance)
T &	X ()
T &	Y ()
T &	Z ()

Public Attributes
T	x
T	y
T	z
	Storage for the vector components, use &x for LW compatibility.

Protected Member Functions
bool	_acquireGlobal ()
virtual bool	available () const
	Check if the global is available.
virtual LWVParmFuncs *	getGlobal ()
	Get the pointer to the global.
LWVParmFuncs *	operator-> ()
	Get the pointer to the global.

Static Protected Attributes
static LWVParmFuncs *	globPtr
	Pointer to the global functions.

Detailed Description

The Variant Parameter Class Wrapper.

The actual value is stored in a Vector3d, and you can treat the VParm as such.

Note:: Since the values are cached in the Vector3d, make sure to VParm::NewTime

Constructor & Destructor Documentation

lwpp::VParm::VParm	(	int	type,
		const std::string	name,
		std::string	plug_name,
		LWChanGroupID	group = `0`,
		double	v = `0.0`
	)

Parameters:

type	Type of VParm
*name	Name of the VParm
*plug_name	Name of the Plugin this VParm belongs to
group	Group to create this VParm in, may be 0
v	Initial value

lwpp::VParm::VParm	(	int	type,
		const std::string	name,
		std::string	plug_name,
		LWChanGroupID	group,
		Vector3d &	v
	)

Parameters:

type	Type of VParm
*name	Name of the VParm
*plug_name	Name of the Plugin this VParm belongs to
group	Group to create this VParm in, may be 0
&v	Initial value

lwpp::VParm::VParm	(	int	type,
		const std::string	name,
		std::string	plug_name,
		ChannelGroup &	group,
		double	v = `0.0`
	)

Parameters:

type	Type of VParm
*name	Name of the VParm
*plug_name	Name of the Plugin this VParm belongs to
group	Group to create this VParm in, may be 0
v	Initial value

lwpp::VParm::VParm	(	int	type,
		const std::string	name,
		std::string	plug_name,
		ChannelGroup &	group,
		Vector3d &	v
	)

Parameters:

type	Type of VParm
*name	Name of the VParm
*plug_name	Name of the Plugin this VParm belongs to
group	Group to create this VParm in, may be 0
&v	Initial value

lwpp::VParm::~VParm ( void )

virtual

Member Function Documentation

bool lwpp::GlobalBase< LWVParmFuncs >::_acquireGlobal ( )

inlineprotectedinherited

template<typename T>

void lwpp::Vector3< T >::Abs ( )

inlineinherited

template<typename T>

T* lwpp::Vector3< T >::asLWVector ( )

inlineinherited

virtual bool lwpp::GlobalBase< LWVParmFuncs >::available ( ) const

inlinevirtualinherited

Check if the global is available.

void lwpp::VParm::Clear ( )

inline

template<typename T >

Vector3< T > lwpp::Vector3< T >::Cross ( Vector3< T > a ) const

inlineinherited

template<typename T >

T lwpp::Vector3< T >::Dot ( Vector3< T > a ) const

inlineinherited

Get the Dot product.

virtual LWVParmFuncs * lwpp::GlobalBase< LWVParmFuncs >::getGlobal ( )

inlinevirtualinherited

Get the pointer to the global.

double lwpp::VParm::GetValue ( ) const

inline

float lwpp::VParm::GetValuef ( ) const

inline

LWVParmID lwpp::VParm::ID ( )

inline

Return the LWVParmID for the current object.

bool lwpp::VParm::isEnveloped ( )

inline

LWError lwpp::VParm::Load ( const lwpp::LoadState & ls )

virtual

Load a VParm from a LW scene/object.

Reimplemented from lwpp::Storeable.

template<typename T>

T lwpp::Vector3< T >::Magnitude ( ) const

inlineinherited

Return the Length/Magnitude of the Vector3.

void lwpp::VParm::NewTime ( LWTime t )

inline

Update the current time value (which is cached for faster access)

template<typename T >

Vector3< T > & lwpp::Vector3< T >::Normalize ( )

inlineinherited

Normalize the Vector3.

template<typename T>

Vector3 lwpp::Vector3< T >::operator* ( Vector3< T > b )

inlineinherited

template<typename T>

Vector3 lwpp::Vector3< T >::operator* ( double b )

inlineinherited

template<typename T>

Vector3& lwpp::Vector3< T >::operator*= ( Vector3< T > b )

inlineinherited

template<typename T>

Vector3& lwpp::Vector3< T >::operator*= ( T b )

inlineinherited

template<typename T>

Vector3 lwpp::Vector3< T >::operator+ ( Vector3< T > b )

inlineinherited

Add a Vector3.

template<typename T>

Vector3& lwpp::Vector3< T >::operator+= ( Vector3< T > b )

inlineinherited

operator /// Add a Vector3

template<typename T>

Vector3 lwpp::Vector3< T >::operator- ( Vector3< T > b )

inlineinherited

Subtract a Vector3.

template<typename T>

Vector3& lwpp::Vector3< T >::operator-= ( Vector3< T > b )

inlineinherited

Subtract a Vector3.

LWVParmFuncs * lwpp::GlobalBase< LWVParmFuncs >::operator-> ( )

inlineinherited

Get the pointer to the global.

template<typename T>

Vector3 lwpp::Vector3< T >::operator/ ( Vector3< T > b )

inlineinherited

template<typename T>

Vector3 lwpp::Vector3< T >::operator/ ( T b )

inlineinherited

template<typename T>

Vector3& lwpp::Vector3< T >::operator/= ( Vector3< T > b )

inlineinherited

template<typename T>

Vector3& lwpp::Vector3< T >::operator/= ( T b )

inlineinherited

VParm & lwpp::VParm::operator= ( const VParm & from )

Copy values.

void lwpp::VParm::Reset ( const double d )

inline

void lwpp::VParm::Reset ( const Vector3d & v )

inline

LWError lwpp::VParm::Save ( const lwpp::SaveState & ss )

virtual

Save a VParm to a LW scene/object.

Reimplemented from lwpp::Storeable.

void lwpp::VParm::Set ( const double d )

inline

Set the current time Value to a new Value.

void lwpp::VParm::Set ( const Vector3d & v )

inline

void lwpp::VParm::Set ( const LWDVector v )

inline

void lwpp::VParm::Set ( const LWFVector v )

inline

template<typename T>

T lwpp::Vector3< T >::SphericalPhi ( )

inlineinherited

template<typename T>

T lwpp::Vector3< T >::SphericalTheta ( )

inlineinherited

template<typename T>

void lwpp::Vector3< T >::Translate	(	Vector3< T >	dir,
		T	distance
	)

inlineinherited

template<typename T>

T& lwpp::Vector3< T >::X ( )

inlineinherited

template<typename T>

T& lwpp::Vector3< T >::Y ( )

inlineinherited

template<typename T>

T& lwpp::Vector3< T >::Z ( )

inlineinherited

Member Data Documentation

LWVParmFuncs * lwpp::GlobalBase< LWVParmFuncs >::globPtr

staticprotectedinherited

Pointer to the global functions.

template<typename T>

T lwpp::Vector3< T >::x

inherited

template<typename T>

T lwpp::Vector3< T >::y

inherited

template<typename T>

T lwpp::Vector3< T >::z

inherited

Storage for the vector components, use &x for LW compatibility.

The documentation for this class was generated from the following files:

Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation