iXrefAtmos.h

Go to the documentation of this file.

//**************************************************************************/
// Copyright (c) 1998-2005 Autodesk, Inc.
// All rights reserved.
// 
// These coded instructions, statements, and computer programs contain
// unpublished proprietary information written by Autodesk, Inc., and are
// protected by Federal copyright law. They may not be disclosed to third
// parties or copied or duplicated in any form, in whole or in part, without
// the prior written consent of Autodesk, Inc.
//**************************************************************************/
// DESCRIPTION: Interface to xref Atmospherics
// AUTHOR: Attila Szabo - created Feb.03.2005
//***************************************************************************/

#pragma once

#include "..\ifnpub.h"
#include "..\sfx.h"


// Forward declarations
class Animatable;

#define IID_XREF_ATMOS Interface_ID(0x2672319a, 0x657b4bc1)


class IXRefAtmospheric : public Atmospheric, public FPMixinInterface
{
public:
    Class_ID ClassID() { return XREFATMOS_CLASS_ID; }       
    SClass_ID SuperClassID() { return ATMOSPHERIC_CLASS_ID; }
    

    virtual Atmospheric* GetSourceAtmospheric(bool resolveNestedXRef = false) = 0;


    static bool Is_IXRefAtmospheric(Animatable& animatable);

    using FPMixinInterface::GetInterface;

    static IXRefAtmospheric* GetInterface(InterfaceServer& is) {
        return static_cast<IXRefAtmospheric*>(is.GetInterface(IID_XREF_ATMOS));
    };

    // From FPMixinInterface
    virtual Interface_ID GetID() { return IID_XREF_ATMOS; }
    virtual FPInterfaceDesc* GetDesc() { return &mFPInterfaceDesc; }
    static FPInterfaceDesc mFPInterfaceDesc;

    // --- Function publishing
    enum {
        kfpGetSourceAtm,
    };

    BEGIN_FUNCTION_MAP
        FN_1(kfpGetSourceAtm, TYPE_REFTARG, GetSourceAtmospheric, TYPE_bool);
    END_FUNCTION_MAP
};

inline bool IXRefAtmospheric::Is_IXRefAtmospheric(Animatable& animatable) {

    return ((animatable.SuperClassID() == ATMOSPHERIC_CLASS_ID) &&
                    (animatable.ClassID() == XREFATMOS_CLASS_ID));
}