0031939: Coding - correction of spelling errors in comments [part 4]

[occt.git] / src / IGESDraw / IGESDraw_View.hxx

// Created on: 1993-01-11
// Created by: CKY / Contract Toubro-Larsen ( Niraj RANGWALA )
// Copyright (c) 1993-1999 Matra Datavision
// Copyright (c) 1999-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 _IGESDraw_View_HeaderFile
#define _IGESDraw_View_HeaderFile

#include <Standard.hxx>
#include <Standard_Type.hxx>

#include <Standard_Integer.hxx>
#include <Standard_Real.hxx>
#include <IGESData_ViewKindEntity.hxx>
#include <Standard_Boolean.hxx>
class IGESGeom_Plane;
class Standard_OutOfRange;
class IGESData_ViewKindEntity;
class IGESData_TransfEntity;
class gp_XYZ;


class IGESDraw_View;
DEFINE_STANDARD_HANDLE(IGESDraw_View, IGESData_ViewKindEntity)

//! defines IGES View Entity, Type <410> Form <0>
//! in package IGESDraw
//!
//! Used to define a framework for specifying a viewing
//! orientation of an object in three dimensional model
//! space (X,Y,Z). The framework is also used to support
//! the projection of all or part of model space onto a
//! view volume.
class IGESDraw_View : public IGESData_ViewKindEntity
{

public:

  
  Standard_EXPORT IGESDraw_View();
  
  //! This method is used to set fields of the class View
  //! - aViewNum     : View number
  //! - aScale       : Scale factor
  //! - aLeftPlane   : Left   plane of view volume
  //! - aTopPlane    : Top    plane of view volume
  //! - aRightPlane  : Right  plane of view volume
  //! - aBottomPlane : Bottom plane of view volume
  //! - aBackPlane   : Back   plane of view volume
  //! - aFrontPlane  : Front  plane of view volume
  Standard_EXPORT void Init (const Standard_Integer aViewNum, const Standard_Real aScale, const Handle(IGESGeom_Plane)& aLeftPlane, const Handle(IGESGeom_Plane)& aTopPlane, const Handle(IGESGeom_Plane)& aRightPlane, const Handle(IGESGeom_Plane)& aBottomPlane, const Handle(IGESGeom_Plane)& aBackPlane, const Handle(IGESGeom_Plane)& aFrontPlane);
  
  //! Returns True (for a single view)
  Standard_EXPORT Standard_Boolean IsSingle() const Standard_OVERRIDE;
  
  //! Returns 1 (single view)
  Standard_EXPORT Standard_Integer NbViews() const Standard_OVERRIDE;
  
  //! For a single view, returns <me> whatever <num>
  Standard_EXPORT Handle(IGESData_ViewKindEntity) ViewItem (const Standard_Integer num) const Standard_OVERRIDE;
  
  //! returns integer number identifying view orientation
  Standard_EXPORT Standard_Integer ViewNumber() const;
  
  //! returns the scale factor(Default = 1.0)
  Standard_EXPORT Standard_Real ScaleFactor() const;
  
  //! returns False if left side of view volume is not present
  Standard_EXPORT Standard_Boolean HasLeftPlane() const;
  
  //! returns the left side of view volume, or null handle
  Standard_EXPORT Handle(IGESGeom_Plane) LeftPlane() const;
  
  //! returns False if top of view volume is not present
  Standard_EXPORT Standard_Boolean HasTopPlane() const;
  
  //! returns the top of view volume, or null handle
  Standard_EXPORT Handle(IGESGeom_Plane) TopPlane() const;
  
  //! returns False if right side of view volume is not present
  Standard_EXPORT Standard_Boolean HasRightPlane() const;
  
  //! returns the right side of view volume, or null handle
  Standard_EXPORT Handle(IGESGeom_Plane) RightPlane() const;
  
  //! returns False if bottom of view volume is not present
  Standard_EXPORT Standard_Boolean HasBottomPlane() const;
  
  //! returns the bottom of view volume, or null handle
  Standard_EXPORT Handle(IGESGeom_Plane) BottomPlane() const;
  
  //! returns False if back of view volume is not present
  Standard_EXPORT Standard_Boolean HasBackPlane() const;
  
  //! returns the back of view volume, or null handle
  Standard_EXPORT Handle(IGESGeom_Plane) BackPlane() const;
  
  //! returns False if front of view volume is not present
  Standard_EXPORT Standard_Boolean HasFrontPlane() const;
  
  //! returns the front of view volume, or null handle
  Standard_EXPORT Handle(IGESGeom_Plane) FrontPlane() const;
  
  //! returns the Transformation Matrix
  Standard_EXPORT Handle(IGESData_TransfEntity) ViewMatrix() const;
  
  //! returns XYZ from the Model space to the View space by
  //! applying the View Matrix
  Standard_EXPORT gp_XYZ ModelToView (const gp_XYZ& coords) const;




  DEFINE_STANDARD_RTTIEXT(IGESDraw_View,IGESData_ViewKindEntity)

protected:




private:


  Standard_Integer theViewNumber;
  Standard_Real theScaleFactor;
  Handle(IGESGeom_Plane) theLeftPlane;
  Handle(IGESGeom_Plane) theTopPlane;
  Handle(IGESGeom_Plane) theRightPlane;
  Handle(IGESGeom_Plane) theBottomPlane;
  Handle(IGESGeom_Plane) theBackPlane;
  Handle(IGESGeom_Plane) theFrontPlane;


};







#endif // _IGESDraw_View_HeaderFile