Bcf_2_1Components.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
#ifndef _BCF_2_1_COMPONENTS_H
#define _BCF_2_1_COMPONENTS_H
 
#include "BcfCommon.h"
 
#include "BcfElement.h"

namespace OdBcf_2_1 {
 
  class OdBcfViewSetupHints;
  typedef OdSmartPtr<OdBcfViewSetupHints> OdBcfViewSetupHintsPtr;
 
  class OdBcfComponentSelection;
  typedef OdSmartPtr<OdBcfComponentSelection> OdBcfComponentSelectionPtr;
 
  class OdBcfComponentVisibility;
  typedef OdSmartPtr<OdBcfComponentVisibility> OdBcfComponentVisibilityPtr;
 
  class OdBcfComponentColoring;
  typedef OdSmartPtr<OdBcfComponentColoring> OdBcfComponentColoringPtr;
 
  class OdBcfSession;

  class BCF_2_1_EXPORT OdBcfComponents : public OdBcf::OdBcfElement
  {
  public:
 
    //DOM-IGNORE-BEGIN
    ODRX_DECLARE_MEMBERS(OdBcfComponents);
    //DOM-IGNORE-END

    static OdSmartPtr<OdBcfComponents> createObject(
      const OdBcfComponentVisibilityPtr &pVisibility,
      const OdBcfViewSetupHintsPtr      &pViewSetupHints = OdBcfViewSetupHintsPtr(),
      const OdBcfComponentSelectionPtr  &pSelection = OdBcfComponentSelectionPtr(),
      const OdBcfComponentColoringPtr   &pColoring = OdBcfComponentColoringPtr());

    virtual OdResult inFields(TiXmlElement *pParent) ODRX_OVERRIDE;

    virtual OdResult outFields(TiXmlElement *pParent) const ODRX_OVERRIDE;

    const OdBcfViewSetupHintsPtr& getViewSetupHints() const;

    bool isViewSetupHintsUnset() const;

    const OdBcfComponentSelectionPtr& getSelection() const;

    bool isSelectionUnset() const;

    const OdBcfComponentVisibilityPtr& getVisibility() const;

    bool isVisibilityUnset() const;

    const OdBcfComponentColoringPtr& getColoring() const;

    bool isColoringUnset() const;
 
    //DOM-IGNORE-BEGIN
  protected:
    OdBcfViewSetupHintsPtr      m_pViewSetupHints;
    OdBcfComponentSelectionPtr  m_pSelection;
    OdBcfComponentVisibilityPtr m_pVisibility;
    OdBcfComponentColoringPtr   m_pColoring;

    virtual bool validateData() const ODRX_OVERRIDE;
 
    friend OdBcfSession;
    //DOM-IGNORE-END
  };

  typedef OdSmartPtr<OdBcfComponents> OdBcfComponentsPtr;
 
} //namespace OdBcf_2_1
 
#endif // _BCF_2_1_COMPONENTS_H