[occt.git] / src / TDataXtd / TDataXtd_Plane.hxx

// Created on: 2009-04-06
// Created by: Sergey ZARITCHNY
// Copyright (c) 2009-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef _TDataXtd_Plane_HeaderFile
#define _TDataXtd_Plane_HeaderFile

#include <TDataStd_GenericEmpty.hxx>
class TDF_Label;
class gp_Pln;


class TDataXtd_Plane;
DEFINE_STANDARD_HANDLE(TDataXtd_Plane, TDataStd_GenericEmpty)

//! The basis to define a plane attribute.
//! Warning:  Use TDataXtd_Geometry  attribute  to retrieve  the
//! gp_Pln of the Plane attribute
class TDataXtd_Plane : public TDataStd_GenericEmpty
{

public:

  
  //! class methods
  //! =============
  //!
  //! Returns the GUID for plane attributes.
  Standard_EXPORT static const Standard_GUID& GetID();
  
  //! Finds or creates the plane attribute defined by
  //! the label label.
  //! Warning
  //! If you are creating the attribute with this syntax, a
  //! planar face should already be associated with label.
  Standard_EXPORT static Handle(TDataXtd_Plane) Set (const TDF_Label& label);
  
  //! Finds,  or creates,  a Plane  attribute  and sets <P>  as
  //! generated the associated NamedShape.
  //! Plane methods
  //! =============
  Standard_EXPORT static Handle(TDataXtd_Plane) Set (const TDF_Label& label, const gp_Pln& P);
  
  Standard_EXPORT TDataXtd_Plane();
  
  Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
  
  Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;


  DEFINE_DERIVED_ATTRIBUTE(TDataXtd_Plane, TDataStd_GenericEmpty)

protected:


private:


};


#endif // _TDataXtd_Plane_HeaderFile
Commit	Line	Data
42cf5bc1	1	// Created on: 2009-04-06
	2	// Created by: Sergey ZARITCHNY
	3	// Copyright (c) 2009-2014 OPEN CASCADE SAS
	4	//
	5	// This file is part of Open CASCADE Technology software library.
	6	//
	7	// This library is free software; you can redistribute it and/or modify it under
	8	// the terms of the GNU Lesser General Public License version 2.1 as published
	9	// by the Free Software Foundation, with special exception defined in the file
	10	// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
	11	// distribution for complete text of the license and disclaimer of any warranty.
	12	//
	13	// Alternatively, this file may be used under the terms of Open CASCADE
	14	// commercial license or contractual agreement.
	15
	16	#ifndef _TDataXtd_Plane_HeaderFile
	17	#define _TDataXtd_Plane_HeaderFile
	18
c99ad5d7	19	#include <TDataStd_GenericEmpty.hxx>
42cf5bc1	20	class TDF_Label;
42cf5bc1	21	class gp_Pln;
42cf5bc1	22
	23
	24	class TDataXtd_Plane;
c99ad5d7	25	DEFINE_STANDARD_HANDLE(TDataXtd_Plane, TDataStd_GenericEmpty)
42cf5bc1	26
	27	//! The basis to define a plane attribute.
	28	//! Warning: Use TDataXtd_Geometry attribute to retrieve the
	29	//! gp_Pln of the Plane attribute
c99ad5d7	30	class TDataXtd_Plane : public TDataStd_GenericEmpty
42cf5bc1	31	{
	32
	33	public:
	34
	35
	36	//! class methods
	37	//! =============
	38	//!
	39	//! Returns the GUID for plane attributes.
	40	Standard_EXPORT static const Standard_GUID& GetID();
	41
	42	//! Finds or creates the plane attribute defined by
	43	//! the label label.
	44	//! Warning
	45	//! If you are creating the attribute with this syntax, a
	46	//! planar face should already be associated with label.
	47	Standard_EXPORT static Handle(TDataXtd_Plane) Set (const TDF_Label& label);
	48
	49	//! Finds, or creates, a Plane attribute and sets <P> as
	50	//! generated the associated NamedShape.
	51	//! Plane methods
	52	//! =============
	53	Standard_EXPORT static Handle(TDataXtd_Plane) Set (const TDF_Label& label, const gp_Pln& P);
	54
	55	Standard_EXPORT TDataXtd_Plane();
	56
79104795	57	Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
42cf5bc1	58
42cf5bc1	59	Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
	60
	61
c99ad5d7	62	DEFINE_DERIVED_ATTRIBUTE(TDataXtd_Plane, TDataStd_GenericEmpty)
42cf5bc1	63
	64	protected:
	65
	66
	67
	68
	69	private:
	70
	71
	72
	73
	74	};
	75
	76
	77
	78
	79
	80
	81
	82	#endif // _TDataXtd_Plane_HeaderFile