u_transform.h

Go to the documentation of this file.

/* Copyright, 2001 Nevrax Ltd.
 *
 * This file is part of NEVRAX NEL.
 * NEVRAX NEL is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.

 * NEVRAX NEL is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with NEVRAX NEL; see the file COPYING. If not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
 * MA 02111-1307, USA.
 */

#ifndef NL_U_TRANSFORM_H
#define NL_U_TRANSFORM_H

#include "nel/misc/types_nl.h"
#include "nel/misc/rgba.h"
#include "u_instance_group.h"
#include "u_transformable.h"


namespace NL3D
{

using NLMISC::CVector;
using NLMISC::CMatrix;
using NLMISC::CQuat;

class   ILogicInfo;
class   CCluster;

// ***************************************************************************
class UTransform : public UTransformable
{
public:
    // Enum should be the same than in CHrcTrav.

    enum    TVisibility
    {
        Show=0,     // The model is shown in the hierarchy
        Hide,       // The model is hidden in the hierarchy
        Herit,      // The model herit the visibilty from his father

        VisibilityCount
    };


public:


    // @{
    void            parent(UTransform newFather);


    void            setClusterSystem (UInstanceGroup *pIG);
    UInstanceGroup  *getClusterSystem () const;
// @}


    // @{
    void            hide();
    void            show();
    /*
     *  Enable / disable user clipping. If enable, the transform is not clipped into the engine.
     *  The user has to use show / hide to clip or not the transform.
     */
    void            setUserClipping(bool enable);
    bool            getUserClipping() const;
    void            heritVisibility();
    TVisibility     getVisibility();
    // @}


    // @{
    void            freezeHRC();


    void            unfreezeHRC();
    // @}


    // @{
    void            setUserLightable(bool enable);

    bool            getUserLightable() const ;
    // @}


    void            setOrderingLayer(uint layer);

    uint            getOrderingLayer() const;


    void            setLogicInfo(ILogicInfo *logicInfo);


    bool            getLastWorldVisState() const;

    bool            getLastClippedState() const;

    void            getLastParentClusters(std::vector<CCluster*> &clusters) const;

    const CMatrix   &getLastWorldMatrixComputed() const ;


    // @{

    void            setLoadBalancingGroup(const std::string &group);

    const std::string   &getLoadBalancingGroup() const ;

    // @}


    // @{

    void            setMeanColor(NLMISC::CRGBA color);

    NLMISC::CRGBA   getMeanColor() const ;

    bool        supportFastIntersect() const;
    bool        fastIntersect(const NLMISC::CVector &p0, const NLMISC::CVector &dir, float &dist2D, float &distZ, bool computeDist2D);

    // @}

    // @{
    void            setTransparency(bool v);
    void            setOpacity(bool v);
    // return a non-zero value if true
    uint32          isOpaque();
    uint32          isTransparent();
    void            setBypassLODOpacityFlag(bool bypass);

    void            setTransparencyPriority(uint8 priority);
    // @}

    // @{
    void            enableCastShadowMap(bool state);
    bool            canCastShadowMap() const;

    void            enableReceiveShadowMap(bool state);
    bool            canReceiveShadowMap() const ;

    void                setShadowMapDirectionZThreshold(float zthre);
    float               getShadowMapDirectionZThreshold() const;

    void                setShadowMapMaxDepth(float depth);
    float               getShadowMapMaxDepth() const;

    // @}

    void            setForceClipRoot(bool forceClipRoot);
    bool            getForceClipRoot() const;


    UTransform() { _Object = NULL; }
    UTransform(class CTransform *object) { _Object = (ITransformable*)object; };
    void            attach(class CTransform *object) { _Object = (ITransformable*)object; }
    void            detach() { _Object = NULL; }
    bool            empty() const {return _Object==NULL;}
    class CTransform    *getObjectPtr() const {return (CTransform*)(_Object);}
};


} // NL3D


#endif // NL_U_TRANSFORM_H

/* End of u_transform.h */