Channel.h

Go to the documentation of this file.

//! @file Channel.h
//! @brief CChannel class definition which is the base class for object channels (UV, normals...)
//!
//////////////////////////////////////////////////////////////////////
 
#if !defined(AFX_CHANNEL_H__79EB93C1_8866_11D3_A029_8FE73A9B677B__INCLUDED_)
#define AFX_CHANNEL_H__79EB93C1_8866_11D3_A029_8FE73A9B677B__INCLUDED_
 
#ifdef _MSC_VER
#pragma once
#endif // _MSC_VER
 
#include "PointList.h"
#include "FaceList.h"
#include "CustomData.h"
 
#if !defined(MOOTOOLS_CRUNCHERSDK)
#include "ChannelPrivate.h"
#endif
 
BEGIN_MOOTOOLS_NAMESPACE
 
//! @enum Channel3DType
//! @brief The channel type which can be used to cast to the appropriate class
//! Bitwise operations can be use to test several kind of channel
typedef enum Channel3DType
{
    CHANNEL_TYPE_UNDEFINED = 0x00,
    CHANNEL_UNKNOWN = 0x00,
    UVW_CHANNEL = 0x01,             //!< Texture channel
    VC_CHANNEL = 0x04,              //!< Vertex color channel
    WEIGHT_CHANNEL = 0x08,          //!< Float value channel
    POINT_NORMAL_CHANNEL  = 0x10,   //!< Autogenerated point normal channel (one or several normals per point)
    FACE_NORMAL_CHANNEL  = 0x20,    //!< Autogenerated face normal channel (one normal per face)
    SPEC_NORMAL_CHANNEL  = 0x40,    //!< User specified normals channel
    ALL_CHANNELS_TYPE = 0xFFFF,
} Channel3DType;
 
#define UVW_DEFAULT_CHANNNEL_ID (CDependentChannels::GetFirstChannelIDByType(UVW_CHANNEL))
#define VC_DEFAULT_CHANNNEL_ID (CDependentChannels::GetFirstChannelIDByType(VC_CHANNEL))
#define WEIGHT_DEFAULT_CHANNNEL_ID (CDependentChannels::GetFirstChannelIDByType(WEIGHT_CHANNEL))
#define POINT_NORMAL_DEFAULT_CHANNNEL_ID (CDependentChannels::GetFirstChannelIDByType(POINT_NORMAL_CHANNEL))
#define FACE_NORMAL_DEFAULT_CHANNNEL_ID (CDependentChannels::GetFirstChannelIDByType(FACE_NORMAL_CHANNEL))
#define SPEC_NORMAL_DEFAULT_CHANNNEL_ID (CDependentChannels::GetFirstChannelIDByType(SPEC_NORMAL_CHANNEL))
 
typedef enum CHANNEL_COPY_FLAGS
{
    CHANNEL_COPY_DEFAULT = 0x00,
    CHANNEL_COPY_INHERIT_ID = 0x01, // Inherits ID
    CHANNEL_COPY_ONLY_VALID = 0x02, // Copy only valid channels
    CHANNEL_COPY_ADD = 0x04, // Add the copy to the channel list
    CHANNEL_COPY_EMPTY = 0x08, // Do not copy information
    CHANNEL_COPY_USEFUL_ONLY = 0x10, // Do not copy channels computed in real time such normals or uvw computed by maaping projection
    CHANNEL_COPY_CLONE = 0x20, // Duplicate the channel pointer
} CHANNEL_COPY_FLAGS;
 
typedef enum CHANNEL_PROPERTIES
{
    CHANNEL_NONE = 0x00,
    CHANNEL_IS_INVALID = 0x01, // The channel is invalid and must not be used
    CHANNEL_CACHE_DATA = 0x02, // The channel as internal data which might need to be recomputed (ie CSpecNormalChannel). This flag is dependent of the channel type.
    CHANNEL_INVALID_CACHE = 0x04, // The channel cache should be recomputed
    CHANNEL_IS_AUTOGENERATED = 0x08, // The channel is computed on the fly (not user defined)
    CHANNEL_SUPPORT_INCOMPLETE_FACES = 0x10, // Faces can refer to point index which have the POINT_IS_UNUSED flags
    CHANNEL_HAS_NO_FACE_OR_POINT = 0x20, // The channel does not have face or point but some data of other purpose (it is not destroyed during clean operation, if face size mismatch)
    CHANNEL_RECOMPUTE_ON_TRIANGULATION = 0x40, // Triangulation requires the channel to be invalidated
 
    CHANNEL_USER_PROPERTIES1 = 0x01000000,
    CHANNEL_USER_PROPERTIES2 = 0x02000000,
    CHANNEL_USER_PROPERTIES3 = 0x04000000,
    CHANNEL_USER_PROPERTIES4 = 0x08000000,
} CHANNEL_PROPERTIES;
 
//! @struct ChannelConnectionInfo
//! @brief Used by GetChannelPointsConnectedToPoint
typedef struct ChannelConnectionInfo
{
    int chnindex;
    int face;
} ChannelConnectionInfo;
 
//! @class CChannel
//! @brief A CChannel is the base class for some additional information associated to an object.
//! @details CChannel is used to store UV textures, vertex colors or anything else through different channel classes (CUVWChannel, CVCChannel, CPointNormalChannel, CSpecNormalChannel...).
//! @par
//! CChannel usually contains faces and points, but not necessary such CFaceNormalChannel with only contains a list of vector (one vector per geometry face).\n
//! When CChannel has faces, **it is assumes** that CChannel::GetFaceList::GetSize = C3DFaceList::GetSize.\n
//! Some channel faces might be unused, and it that case it is flag with FACE_IS_UNUSED, meaning that the face has no relative data.\n
//! A CChannel with faces can have any number of points. This number is not necessary the same than object 3D points number, as you can have one or more information per 3D points.\n
//! @par
//! CChannel integrates a Clean method which make easier synchronisation between the 3D points and the channel points. Each #i face in the channel is removed if the corresponding face #i face in the object C3DFaceList has the FACE_IS_INVALID flag.
class DLL_3DFUNCTION CChannel : public CXObject, public CInstanciatedObject
{
    friend CDependentChannels;
 
    DECLARE_SERIAL_XOBJECT(CChannel);
 
public:
    CChannel(ChannelID id = CHANNELID_UNDEFINED); //!< You may assign a specific channel id at creation. This is useful to make a known reference between material and front / back UV channel for example. Note : 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 ~CChannel(); //!< Use Delete instead, unless the CChannel is created on the stack (take care that it is referenced once only in this case)
 
    static CChannel *Create(Channel3DType type, ChannelID id = CHANNELID_UNDEFINED); //!< Allocates and creates a new channel. Use Delete if the channel is not attached to a CDependentChannel list.  //!< 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
 
    //! @name Flags informations
    //! @{
    void SetFlag(CHANNEL_PROPERTIES flag, bool set);
    void SetFlags(unsigned int newflags, bool set);
    bool IsFlagSet(unsigned int flag) const;
    bool IsOneFlagSet(unsigned int flag) const;
    CCustomData& GetCustomData();
    ChannelID GetChannelID() const; //!< The channel ID allows to rely a specific material to a specific channel. This is not a GUID (different object might different channel with the same ID, allowing a material to retrieve the UV channel to use for example)
    CXString GetTypeString() const;
 
    //! @}
 
    //! @name Channel informations
    //! @{
    CFaceList *GetFaceList();
    CPointList *GetPointList();
 
    //! @}
 
    //! @name Channel information
    //! @{
    void SetFaceList(Channel3DType channeltype, CFaceList *newfaces, bool deletePrevious = true); //!< Attach a face list to the channel. newfaces is owned by the channel, and should not be deleted by the caller
    void SetPointList(Channel3DType channeltype, CPointList *newpoints, bool deletePrevious = true);  //!< Attach a point list to the channel. newpoints is owned by the channel, and should not be deleted by the caller
    Channel3DType GetType() const;
 
    //! @}
 
    void FreeExtra(); //!< Release any extra memory attached to the channel
 
    //! @name graph functions
    //! @{
    void InitGraph(const CGeomInfo *);
    void DeleteGraph();
    ChannelConnectionInfo *GetChannelPointsConnectedToPoint(int point, int& size); //!< Return UVs connected to the point. size is the number of ChannelConnectionInfo * array entries for point index
    ChannelConnectionInfo *GetChannelPointsConnectedToPoint(int point, int& size, int& facesize); //!< facesize is the number of faces connected to the point, which might be different than size if some face has invalid or unused UV
    CPt *GetChannelPointIndex(int facenbr, int pointindex);
 
    //! @}
 
    //! @name Operation on the channel
    //! @{
    virtual bool SwapCoordinates(unsigned int swapMode);
    virtual bool MatrixTransform(const C4x4Matrix& matrix, POINT_PROPERTIES property = POINT_NONE, bool set = TRUE, int index = 0, int count = -1);
    virtual bool CleanRemoveDuplicateIndex();
    virtual bool Clean(const CGeomInfo *info, CXUIntArray *newfaceindex = NULL, CXUIntArray *newpointindex = NULL);
    virtual bool Weld(const CGeomInfo *info, double tolerance);
 
    //! @}
 
    //! @name virtual function
    //! @{
    virtual bool Compare(const CChannel *channel) const; //!< Return true if the channel have same type and same content
    virtual bool Compare(const CPt *pt1, const CPt *pt2, double tolerance = 0.0f) const;
    virtual void Serialize(CXArchive& ar);
    virtual bool CanBeRecomputed();
    virtual void Inherit(const CChannel& srcChannels);
    virtual CChannel *Copy(unsigned int copyFlags) const;
 
    //! @}
 
#ifdef _DEBUG
    unsigned int MemoryStats() const;
#endif
 
protected:
    ChannelID channelID; // A single identifier (for a given Channel3DType). If channelID == CHANNELID_UNDEFINED, then an ID will be assigned when adding the channel to the CDependentChannels
    Channel3DType type;
    unsigned int flags;
 
    CPointList *channelPoints;
    CFaceList *channelFaces;
    CCustomData data;
 
    CChannelGraph *chnGraph;
    int chnGraphLock;
 
    unsigned int faceStamp, chnFaceStamp;
 
    void CreateGraph(const CGeomInfo *); // Use InitGraph
    void SetChannelID(ChannelID id); // Assign a new channel ID. Call through CDependentChannel which ensure its single for a given type
};
 
END_MOOTOOLS_NAMESPACE
 
#endif // !defined(AFX_CHANNEL_H__79EB93C1_8866_11D3_A029_8FE73A9B677B__INCLUDED_)