WeightChannel.h

Go to the documentation of this file.

//! @file WeightChannel.h
//! @brief CWeightChannel class for handling weight channel
//!
//////////////////////////////////////////////////////////////////////
 
#if !defined(WEIGHTCHANNEL_INCLUDE)
#define WEIGHTCHANNEL_INCLUDE
 
#ifdef _MSC_VER
#pragma once
#endif // _MSC_VER
 
#include "Channel.h"
 
BEGIN_MOOTOOLS_NAMESPACE
 
//! @class CWeightChannel
//! @brief CWeightChannel is the channel class dedicated to weight information.
//! @details CWeightChannel belongs to CDependentChannels and is referenced by the WEIGHT_CHANNEL identifier.
class DLL_3DFUNCTION CWeightChannel : public CChannel  
{
    DECLARE_SERIAL_XOBJECT(CWeightChannel);
 
public:
    CWeightChannel(ChannelID id = CHANNELID_UNDEFINED, bool pointOnly = true); // If id = CHANNELID_UNDEFINED, the id is automatically assigned when adding the channel to object channels. If id != CHANNELID_UNDEFINED, the id might be modified if it already exists in object channels
    virtual ~CWeightChannel(); // Use Delete instead, unless the CWeightChannel is created on the stack (take care that it is referenced once only in this case)
 
    // Weight informations
    CWeightFaceList *GetWeightFaceList();
    CWeightPointList *GetWeightPointList();
 
    void GetLimits(real& min, real& max);
    void Normalize(bool invert = false);
    void Invert();
 
    //! Returns a list of WeightPoints which are the average value of the weights of the points of each face of the geominfo. You have to desallocate the returned CPointList* by using CWeightPointList::Delete() when you don't use it anymore.
    CWeightPointList* GetWeightPointOnlyList(CGeomInfo* geominfo);
 
    // Virtuals
    virtual bool Compare(const CPt *pt1, const CPt *pt2, double tolerance = 0.0f) const;
 
protected:
};
 
END_MOOTOOLS_NAMESPACE
 
#endif // !defined(WEIGHTCHANNEL_INCLUDE)