FxVariant.h

Go to the documentation of this file.

//
// (C) Copyright 2005-2025 by Graebert GmbH.
//
// Permission to use, copy, modify, and distribute this software in
// object code form for any purpose and without fee is hereby granted,
// provided that the above copyright notice appears in all copies and
// that both that copyright notice and the limited warranty and
// restricted rights notice below appear in all supporting
// documentation.
//
// GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS.
// GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.  GRAEBERT GMBH
// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
// UNINTERRUPTED OR ERROR FREE.
 
#pragma once
 
#include "DDKERNEL.h"
#include "FxString.h"
 
#include <CmColor.h>
#include <DbDictionary.h>
#include <DbObjectId.h>
#include <Ge/Ge.h>
#include <Ge/GePoint2d.h>
#include <Ge/GePoint3d.h>
#include <OdaCommon.h>
#include <QtCore/QByteArray>
 
#include <vector>
 
 
class CFxVariant;
class CFxDocument;
 

class DDKERNEL_API CFxVariantCollectionElement
{
public:
    CFxVariantCollectionElement();

    CFxVariantCollectionElement( const CFxVariant& tag, const CFxVariant& value );

    CFxVariantCollectionElement( const CFxVariantCollectionElement& value );

    virtual ~CFxVariantCollectionElement();

    CFxVariantCollectionElement& operator=( const CFxVariantCollectionElement& value );

    CFxVariant* GetTag() const;

    CFxVariant* GetValue() const;

    void SetTag( const CFxVariant& value );

    void SetValue( const CFxVariant& value );
 
protected:
    CFxVariant* _pTag;

    CFxVariant* _pValue;
};

struct DDKERNEL_API CFxVariantCollection
{
    CFxVariantCollection();

    bool operator==( const CFxVariantCollection& collection ) const;

    bool HasVaries() const;

    typedef std::vector<CFxVariantCollectionElement> CONTAINER;

    int _selectedIndex;

    bool _bEditable;

    const CONTAINER& GetCollectionDataForRead() const
    {
        return _collection;
    }

    CONTAINER& GetCollectionDataForWrite()
    {
        return _collection;
    }

    CFxVariant GetActiveItemValue() const;
 
protected:
    CONTAINER _collection;
};

struct DDKERNEL_API FX_VARIANT
{
    FX_VARIANT();

    void* m_pVoid;

    int m_Size;

    double m_Double;
    bool m_UseUnitsConversion;
    CFxString m_String;
    OdInt32 m_Int32;
    OdCmColor m_Color;
    CFxVariantCollectionElement m_CollectionElement;
    CFxVariantCollection m_Collection;
    OdDbObjectId m_Id;
    OdGePoint2d m_Point2D;
    OdGePoint3d m_Point3D;
    OdCmTransparency m_Transparency;
};

class DDKERNEL_API CFxVariant : protected FX_VARIANT
{
public:
    static const char* varies;
    static CFxVariant kNull;

    typedef enum _Type
    {
        eNone,
        eVoid,
        eDouble,
        eString,
        eInt32,
        eColor,
        eCollection,
        eCollectionElement,
        eId,
        ePoint2D,
        ePoint3D,
        eTransparency,
        eAngle,
        eLineType,
        eScale
    } Type;

    CFxVariant();
    
    CFxVariant( const CFxVariant& variant );
    
    CFxVariant( const CFxVariant* pVariant );
    CFxVariant( const void* value, int size );

    CFxVariant( double value, bool useUnitsConversion = true );

    CFxVariant( const CFxString& value );
    
    CFxVariant( OdInt32 value );

    CFxVariant( const OdCmColor& value );

    CFxVariant( const OdCmTransparency& value );

    CFxVariant( const CFxVariantCollection& value );

    CFxVariant( const CFxVariantCollectionElement& value );

    CFxVariant( const OdDbObjectId& value );

    CFxVariant( const OdGePoint2d& value );

    CFxVariant( const OdGePoint3d& value );

    void Load( QByteArray& data, CFxDocument* pContext );

    QByteArray Save() const;

    virtual ~CFxVariant();

    bool IsNull() const;

    Type GetType() const;

    bool UseUnitsConversion() const;

    void* GetVoid( int* size = 0 ) const;

    double GetDouble() const;

    CFxString GetString() const;
    
    OdInt32 GetInt32() const;

    const OdCmColor& GetColor() const;

    const OdCmTransparency& GetTransparency() const;

    CFxVariantCollection& GetCollection();
    
    const CFxVariantCollection& GetCollection() const;

    const CFxVariantCollectionElement& GetCollectionElement() const;

    const OdDbObjectId& GetId() const;

    const OdGePoint2d& GetPoint2d() const;

    const OdGePoint3d& GetPoint3d() const;

    void SetValue( const CFxVariant& value );

    friend DDKERNEL_API bool operator!=( const CFxVariant& v1, const CFxVariant& v2 );
    
    friend DDKERNEL_API bool operator==( const CFxVariant& v1, const CFxVariant& v2 );

    const CFxVariant& operator+=( const CFxVariant& v );
 
protected:
    static void GetIdDescription( OdDbObjectId id, CFxString& sPath, CFxString& sObjectName );
    

    static bool BuildOwnerPath( OdDbDictionaryPtr pRootDict,
                                OdDbObjectId idTarget,
                                const CFxString& sRootName,
                                CFxString& sPath );
    
    static OdDbObjectId ResolvePath( OdDbDictionaryPtr pRootDict,
                                     const CFxString& sPath,
                                     const CFxString& sObjectName );

    Type m_Type;

    bool m_bUseUnitsConversion;
 
private:
    static CFxVariantCollectionElement m_NullCollectionElement;

    static CFxVariantCollection m_NullCollection;
};