1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-04-09 18:50:54 +03:00
occt/src/IGESGraph/IGESGraph_TextFontDef.hxx
dpasukhi a5a7b3185b Coding - Apply .clang-format formatting #286
Update empty method guards to new style with regex (see PR).
Used clang-format 18.1.8.
New actions to validate code formatting is added.
Update .clang-format with disabling of include sorting.
  It is temporary changes, then include will be sorted.
Apply formatting for /src and /tools folder.
The files with .hxx,.cxx,.lxx,.h,.pxx,.hpp,*.cpp extensions.
2025-01-26 00:43:57 +00:00

143 lines
6.6 KiB
C++

// Created on: 1993-01-11
// Created by: CKY / Contract Toubro-Larsen ( TCD )
// 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 _IGESGraph_TextFontDef_HeaderFile
#define _IGESGraph_TextFontDef_HeaderFile
#include <Standard.hxx>
#include <Standard_Type.hxx>
#include <Standard_Integer.hxx>
#include <TColStd_HArray1OfInteger.hxx>
#include <IGESData_IGESEntity.hxx>
class TCollection_HAsciiString;
class IGESBasic_HArray1OfHArray1OfInteger;
class IGESGraph_TextFontDef;
DEFINE_STANDARD_HANDLE(IGESGraph_TextFontDef, IGESData_IGESEntity)
//! defines IGES Text Font Definition Entity, Type <310>
//! in package IGESGraph
//!
//! Used to define the appearance of characters in a text font.
//! It may be used to describe a complete font or a
//! modification to a subset of characters in another font.
class IGESGraph_TextFontDef : public IGESData_IGESEntity
{
public:
Standard_EXPORT IGESGraph_TextFontDef();
//! This method is used to set the fields of the class
//! TextFontDef
//! - aFontCode : Font Code
//! - aFontName : Font Name
//! - aSupersededFont : Number of superseded font
//! - aSupersededEntity : Text Definition Entity
//! - aScale : No. of grid units = 1 text height unit
//! - allASCIICodes : ASCII codes for characters
//! - allNextCharX & Y : Grid locations of the next
//! character's origin (Integer vals)
//! - allPenMotions : No. of pen motions for the characters
//! - allPenFlags : Pen up/down flags,
//! 0 = Down (default), 1 = Up
//! - allMovePenToX & Y : Grid locations the pen will move to
//! This method initializes the fields of the class TextFontDef.
//! An exception is raised if the lengths of allASCIICodes,
//! allNextChars, allPenMotions, allPenFlags and allMovePenTo
//! are not same.
Standard_EXPORT void Init(const Standard_Integer aFontCode,
const Handle(TCollection_HAsciiString)& aFontName,
const Standard_Integer aSupersededFont,
const Handle(IGESGraph_TextFontDef)& aSupersededEntity,
const Standard_Integer aScale,
const Handle(TColStd_HArray1OfInteger)& allASCIICodes,
const Handle(TColStd_HArray1OfInteger)& allNextCharX,
const Handle(TColStd_HArray1OfInteger)& allNextCharY,
const Handle(TColStd_HArray1OfInteger)& allPenMotions,
const Handle(IGESBasic_HArray1OfHArray1OfInteger)& allPenFlags,
const Handle(IGESBasic_HArray1OfHArray1OfInteger)& allMovePenToX,
const Handle(IGESBasic_HArray1OfHArray1OfInteger)& allMovePenToY);
//! returns the font code.
Standard_EXPORT Standard_Integer FontCode() const;
//! returns the font name.
Standard_EXPORT Handle(TCollection_HAsciiString) FontName() const;
//! True if this definition supersedes another
//! TextFontDefinition Entity,
//! False if it supersedes value.
Standard_EXPORT Standard_Boolean IsSupersededFontEntity() const;
//! returns the font number which this entity modifies.
Standard_EXPORT Standard_Integer SupersededFontCode() const;
//! returns the font entity which this entity modifies.
Standard_EXPORT Handle(IGESGraph_TextFontDef) SupersededFontEntity() const;
//! returns the number of grid units which equal one text height unit.
Standard_EXPORT Standard_Integer Scale() const;
//! returns the number of characters in this definition.
Standard_EXPORT Standard_Integer NbCharacters() const;
//! returns the ASCII code of Chnum'th character.
//! Exception OutOfRange is raised if Chnum <= 0 or Chnum > NbCharacters
Standard_EXPORT Standard_Integer ASCIICode(const Standard_Integer Chnum) const;
//! returns grid location of origin of character next to Chnum'th char.
//! Exception OutOfRange is raised if Chnum <= 0 or Chnum > NbCharacters
Standard_EXPORT void NextCharOrigin(const Standard_Integer Chnum,
Standard_Integer& NX,
Standard_Integer& NY) const;
//! returns number of pen motions for Chnum'th character.
//! Exception OutOfRange is raised if Chnum <= 0 or Chnum > NbCharacters
Standard_EXPORT Standard_Integer NbPenMotions(const Standard_Integer Chnum) const;
//! returns pen status(True if 1, False if 0) of Motionnum'th motion
//! of Chnum'th character.
//! Exception raised if Chnum <= 0 or Chnum > NbCharacters or
//! Motionnum <= 0 or Motionnum > NbPenMotions
Standard_EXPORT Standard_Boolean IsPenUp(const Standard_Integer Chnum,
const Standard_Integer Motionnum) const;
Standard_EXPORT void NextPenPosition(const Standard_Integer Chnum,
const Standard_Integer Motionnum,
Standard_Integer& IX,
Standard_Integer& IY) const;
DEFINE_STANDARD_RTTIEXT(IGESGraph_TextFontDef, IGESData_IGESEntity)
protected:
private:
Standard_Integer theFontCode;
Handle(TCollection_HAsciiString) theFontName;
Standard_Integer theSupersededFontCode;
Handle(IGESGraph_TextFontDef) theSupersededFontEntity;
Standard_Integer theScale;
Handle(TColStd_HArray1OfInteger) theASCIICodes;
Handle(TColStd_HArray1OfInteger) theNextCharOriginX;
Handle(TColStd_HArray1OfInteger) theNextCharOriginY;
Handle(TColStd_HArray1OfInteger) theNbPenMotions;
Handle(IGESBasic_HArray1OfHArray1OfInteger) thePenMotions;
Handle(IGESBasic_HArray1OfHArray1OfInteger) thePenMovesToX;
Handle(IGESBasic_HArray1OfHArray1OfInteger) thePenMovesToY;
};
#endif // _IGESGraph_TextFontDef_HeaderFile