PixelLightAPI  .
Public Member Functions
PLMesh::Weight Class Reference

Weight class. More...

#include <Weight.h>

List of all members.

Public Member Functions

PLMESH_API Weight ()
 Constructor.
PLMESH_API ~Weight ()
 Destructor.
PLMESH_API int GetJoint () const
 Get the weight joint number.
PLMESH_API void SetJoint (int nJoint=-1)
 Sets the weight joint number.
PLMESH_API float GetBias () const
 Get the weight bias.
PLMESH_API void SetBias (float fBias=0.0f)
 Sets the weight bias.
PLMESH_API Weightoperator= (const Weight &cSource)
 Copy operator.
PLMESH_API bool operator== (const Weight &cWeight) const
 Compares two weights.

Detailed Description

Weight class.


Constructor & Destructor Documentation

PLMESH_API PLMesh::Weight::Weight ( )

Constructor.

PLMESH_API PLMesh::Weight::~Weight ( )

Destructor.


Member Function Documentation

PLMESH_API int PLMesh::Weight::GetJoint ( ) const

Get the weight joint number.

Returns:
Weight joint number, < 0 on error
PLMESH_API void PLMesh::Weight::SetJoint ( int  nJoint = -1)

Sets the weight joint number.

Parameters:
[in]nJointWeight joint number
PLMESH_API float PLMesh::Weight::GetBias ( ) const

Get the weight bias.

Returns:
Weight bias
Remarks:
Scale factor for the influence. Usually the weights for all influences for a single vertex add up to one.
PLMESH_API void PLMesh::Weight::SetBias ( float  fBias = 0.0f)

Sets the weight bias.

Parameters:
[in]fBiasWeight bias
See also:
PLMESH_API Weight& PLMesh::Weight::operator= ( const Weight cSource)

Copy operator.

Parameters:
[in]cSourceSource to copy from
Returns:
This weight
PLMESH_API bool PLMesh::Weight::operator== ( const Weight cWeight) const

Compares two weights.

Parameters:
[in]cWeightWeight to compare with
Returns:
'true' if both weights are equal, else 'false'

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


PixelLight PixelLight 0.9.10-R1
Copyright (C) 2002-2011 by The PixelLight Team
Last modified Fri Dec 23 2011 15:51:21
The content of this PixelLight document is published under the
Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported