OpenCascade.js
API ReferenceDataExchangeTKDEIGES

IGESGraph

OCCT package IGESGraph: IGESGraph, IGESGraph_Color, IGESGraph_DefinitionLevel, IGESGraph_DrawingSize, and 29 more bound classes.

IGESGraph

This package contains the group of classes necessary to define Graphic data among Structure Entities. (e.g., Fonts, Colors, Screen management ...).

Constructors(1)

Static methods(2)

IGESGraph_Color

defines IGESColor, Type <314> Form <0> in package IGESGraph
The Color Definition Entity is used to communicate the relationship of primary colors to the intensity level of the respective graphics devices as a percent of full intensity range.

Constructors(1)

Static methods(2)

Instance methods(7)

  • Init(red: number, green: number, blue: number, aColorName: TCollection_HAsciiString): void

    This method is used to set the fields of the class Color.

    • red : Red color intensity (range 0.0 to 100.0)
    • green : Green color intensity (range 0.0 to 100.0)
    • blue : Blue color intensity (range 0.0 to 100.0)
    • aColorName : Name of the color (optional)
    Parameters (4)
    • red
    • green
    • blue
    • aColorName
  • RGBIntensity(Red: number, Green: number, Blue: number): { Red: number; Green: number; Blue: number }
    Parameters (3)
    • Red
    • Green
    • Blue
  • CMYIntensity(Cyan: number, Magenta: number, Yellow: number): { Cyan: number; Magenta: number; Yellow: number }
    Parameters (3)
    • Cyan
    • Magenta
    • Yellow
  • HLSPercentage(Hue: number, Lightness: number, Saturation: number): { Hue: number; Lightness: number; Saturation: number }
    Parameters (3)
    • Hue
    • Lightness
    • Saturation
  • HasColorName(): boolean

    returns True if optional character string is assigned, False otherwise.

  • if HasColorName() is True returns the Verbal description of the Color.

IGESGraph_DefinitionLevel

defines IGESDefinitionLevel, Type <406> Form <1> in package IGESGraph
Indicates the no. of levels on which an entity is defined

Constructors(1)

Static methods(2)

Instance methods(5)

  • Init(allLevelNumbers: NCollection_HArray1_int): void

    This method is used to set the fields of the class DefinitionLevel.

    • allLevelNumbers : Values of Level Numbers
    Parameters (1)
    • allLevelNumbers
  • returns the number of property values in <me>

  • NbLevelNumbers(): number

    Must return the count of levels (== NbPropertyValues).

  • LevelNumber(num: number): number

    returns the Level Number of <me> indicated by <LevelIndex> raises an exception if LevelIndex is <= 0 or LevelIndex > NbPropertyValues

    Parameters (1)
    • num

IGESGraph_DrawingSize

defines IGESDrawingSize, Type <406> Form <16> in package IGESGraph
Specifies the drawing size in drawing units. The origin of the drawing is defined to be (0,0) in drawing space

Constructors(1)

Static methods(2)

Instance methods(5)

  • Init(nbProps: number, aXSize: number, aYSize: number): void

    This method is used to set the fields of the class DrawingSize.

    • nbProps : Number of property values (NP = 2)
    • aXSize : Extent of Drawing along positive XD axis
    • aYSize : Extent of Drawing along positive YD axis
    Parameters (3)
    • nbProps
    • aXSize
    • aYSize
  • returns the number of property values in <me> (NP = 2)

  • XSize(): number

    returns the extent of Drawing along positive XD axis

  • YSize(): number

    returns the extent of Drawing along positive YD axis

IGESGraph_DrawingUnits

defines IGESDrawingUnits, Type <406> Form <17> in package IGESGraph
Specifies the drawing space units as outlined in the Drawing entity

Constructors(1)

Static methods(2)

Instance methods(6)

  • Init(nbProps: number, aFlag: number, aUnit: TCollection_HAsciiString): void

    This method is used to set the fields of the class DrawingUnits.

    • nbProps : Number of property values (NP = 2)
    • aFlag : DrawingUnits Flag
    • aUnit : DrawingUnits Name
    Parameters (3)
    • nbProps
    • aFlag
    • aUnit
  • returns the number of property values in <me>

  • Flag(): number

    returns the drawing space units of <me>

  • returns the name of the drawing space units of <me>

  • UnitValue(): number

    Computes the value of the unit, in meters, according Flag (same values as for GlobalSection from IGESData).

IGESGraph_GeneralModule

Definition of General Services for IGESGraph (specific part) This Services comprise : Shared & Implied Lists, Copy, Check.

Constructors(1)

Static methods(2)

Instance methods(6)

IGESGraph_HighLight

defines IGESHighLight, Type <406> Form <20> in package IGESGraph
Attaches information that an entity is to be displayed in some system dependent manner

Constructors(1)

Static methods(2)

Instance methods(5)

  • Init(nbProps: number, aHighLightStatus: number): void

    This method is used to set the fields of the class HighLight.

    • nbProps : Number of property values (NP = 1)
    • aHighLightStatus : HighLight Flag
    Parameters (2)
    • nbProps
    • aHighLightStatus
  • returns the number of property values in <me>

  • HighLightStatus(): number

    returns 0 if <me> is not highlighted(default), 1 if <me> is highlighted

  • IsHighLighted(): boolean

    returns True if entity is highlighted

IGESGraph_IntercharacterSpacing

defines IGESIntercharacterSpacing, Type <406> Form <18> in package IGESGraph
Specifies the gap between letters when fixed-pitch spacing is used

Constructors(1)

Static methods(2)

Instance methods(4)

  • Init(nbProps: number, anISpace: number): void

    This method is used to set the fields of the class IntercharacterSpacing.

    • nbProps : Number of property values (NP = 1)
    • anISpace : Intercharacter spacing percentage
    Parameters (2)
    • nbProps
    • anISpace
  • returns the number of property values in <me>

  • ISpace(): number

    returns the Intercharacter Space of <me> in percentage of the text height (Range = 0..100)

IGESGraph_LineFontDefPattern

defines IGESLineFontDefPattern, Type <304> Form <2> in package IGESGraph
Line Font may be defined by repetition of a basic pattern of visible-blank(or, on-off) segments superimposed on a line or a curve. The line or curve is then displayed according to the basic pattern.

Constructors(1)

Static methods(2)

Instance methods(6)

  • This method is used to set the fields of the class LineFontDefPattern.

    • allSegLength : Containing lengths of respective segments
    • aPattern : HAsciiString indicating visible-blank segments
    Parameters (2)
    • allSegLength
    • aPattern
  • NbSegments(): number

    returns the number of segments in the visible-blank pattern

  • Length(Index: number): number

    returns the Length of Index'th segment of the basic pattern raises exception if Index <= 0 or Index > NbSegments

    Parameters (1)
    • Index
  • returns the string indicating which segments of the basic pattern are visible and which are blanked. e.g: theNbSegments = 5 and if Bit Pattern = 10110, which means that segments 2, 3 and 5 are visible, whereas segments 1 and 4 are blank. The method returns "2H16" as the HAsciiString. Note: The bits are right justified. (16h = 10110)

  • IsVisible(Index: number): boolean

    The Display Pattern is decrypted to return True if the Index'th basic pattern is Visible, False otherwise. If Index > NbSegments or Index <= 0 then return value is False.

    Parameters (1)
    • Index

IGESGraph_LineFontDefTemplate

defines IGESLineFontDefTemplate, Type <304> Form <1> in package IGESGraph
Line Font can be defined as a repetition of Template figure that is displayed at regularly spaced locations along a planer anchoring curve. The anchoring curve itself has no visual purpose.

Constructors(1)

Static methods(2)

Instance methods(6)

  • Init(anOrientation: number, aTemplate: IGESBasic_SubfigureDef, aDistance: number, aScale: number): void

    This method is used to set the fields of the class LineFontDefTemplate.

    • anOrientation : Orientation of Template figure on anchoring curve
    • aTemplate : SubfigureDef entity used as Template figure
    • aDistance : Distance between the neighbouring Template figures
    • aScale : Scale factor applied to the Template figure
    Parameters (4)
    • anOrientation
    • aTemplate
    • aDistance
    • aScale
  • Orientation(): number

    if return value = 0, Each Template display is oriented by aligning the axis of the SubfigureDef with the axis of the definition space of the anchoring curve. = 1, Each Template display is oriented by aligning X-axis of the SubfigureDef with the tangent vector of the anchoring curve at the point of incidence of the curve and the origin of subfigure. Similarly Z-axis is aligned.

  • returns SubfigureDef as the Entity used as Template figure.

  • Distance(): number

    returns the Distance between any two Template figures on the anchoring curve.

  • Scale(): number

    returns the Scaling factor applied to SubfigureDef to form Template figure.

IGESGraph_LineFontPredefined

defines IGESLineFontPredefined, Type <406> Form <19> in package IGESGraph
Provides the ability to specify a line font pattern from a predefined list rather than from Directory Entry Field 4

Constructors(1)

Static methods(2)

Instance methods(4)

  • Init(nbProps: number, aLineFontPatternCode: number): void

    This method is used to set the fields of the class LineFontPredefined.

    • nbProps : Number of property values (NP = 1)
    • aLineFontPatternCode : Line Font Pattern Code
    Parameters (2)
    • nbProps
    • aLineFontPatternCode
  • returns the number of property values in <me>

  • returns the Line Font Pattern Code of <me>

IGESGraph_NominalSize

defines IGESNominalSize, Type <406> Form <13> in package IGESGraph
Specifies a value, a name, and optionally a reference to an engineering standard

Constructors(1)

Static methods(2)

Instance methods(7)

IGESGraph_Pick

defines IGESPick, Type <406> Form <21> in package IGESGraph
Attaches information that an entity may be picked by whatever pick device is used in the receiving system

Constructors(1)

Static methods(2)

Instance methods(5)

  • Init(nbProps: number, aPickStatus: number): void

    This method is used to set the fields of the class Pick.

    • nbProps : Number of property values (NP = 1)
    • aPickStatus : Pick Flag
    Parameters (2)
    • nbProps
    • aPickStatus
  • returns the number of property values in <me>.

  • PickFlag(): number

    returns 0 if <me> is pickable(default), 1 if <me> is not pickable.

  • IsPickable(): boolean

    returns True if thePick is 0.

IGESGraph_Protocol

Description of Protocol for IGESGraph.

Constructors(1)

Static methods(2)

Instance methods(4)

  • NbResources(): number

    Gives the count of Resource Protocol. Here, one (Protocol from IGESBasic).

  • Returns a Resource, given a rank.

    Parameters (1)
    • num
  • TypeNumber(atype: Standard_Type): number

    Returns a Case Number, specific of each recognized Type This Case Number is then used in Libraries : the various Modules attached to this class of Protocol must use them in accordance (for a given value of TypeNumber, they must consider the same Type as the Protocol defines).

    Parameters (1)
    • atype

IGESGraph_ReadWriteModule

Defines Graph File Access Module for IGESGraph (specific parts) Specific actions concern : Read and Write Own Parameters of an IGESEntity.

Constructors(1)

Static methods(2)

Instance methods(2)

IGESGraph_SpecificModule

Defines Services attached to IGES Entities : Dump & OwnCorrect, for IGESGraph.

Constructors(1)

Static methods(2)

Instance methods(2)

  • OwnCorrect(CN: number, ent: IGESData_IGESEntity): boolean

    Performs non-ambiguous Corrections on Entities which support them (DrawingSize,DrawingUnits,HighLight,IntercharacterSpacing, LineFontPredefined,NominalSize,Pick,UniformRectGrid).

    Parameters (2)
    • CN
    • ent

IGESGraph_TextDisplayTemplate

defines IGES TextDisplayTemplate Entity, Type <312>, form <0, 1> in package IGESGraph
Used to set parameters for display of information which has been logically included in another entity as a parameter value

Constructors(1)

Static methods(2)

Instance methods(15)

  • Init(aWidth: number, aHeight: number, aFontCode: number, aFontEntity: IGESGraph_TextFontDef, aSlantAngle: number, aRotationAngle: number, aMirrorFlag: number, aRotationFlag: number, aCorner: gp_XYZ): void

    This method is used to set the fields of the class TextDisplayTemplate.

    • aWidth : Character box width
    • aHeight : Character box height
    • afontCode : Font code
    • aFontEntity : Text Font Definition Entity
    • aSlantAngle : Slant angle
    • aRotationAngle : Rotation angle
    • aMirrorFlag : Mirror Flag
    • aRotationFlag : Rotate internal text flag
    • aCorner : Lower left corner coordinates(Form No. 0), Increments from coordinates (Form No. 1)
    Parameters (9)
    • aWidth
    • aHeight
    • aFontCode
    • aFontEntity
    • aSlantAngle
    • aRotationAngle
    • aMirrorFlag
    • aRotationFlag
    • aCorner
  • SetIncremental(mode: boolean): void

    Sets <me> to be Incremental (Form 1) if <mode> is True, or Basolute (Form 0) else.

    Parameters (1)
    • mode
  • IsIncremental(): boolean

    returns True if entity is Incremental (Form 1). False if entity is Absolute (Form 0).

  • BoxWidth(): number

    returns Character Box Width.

  • BoxHeight(): number

    returns Character Box Height.

  • IsFontEntity(): boolean

    returns False if theFontEntity is Null, True otherwise.

  • FontCode(): number

    returns the font code.

  • returns Text Font Definition Entity used to define the font.

  • SlantAngle(): number

    returns slant angle of character in radians.

  • RotationAngle(): number

    returns Rotation angle of text block in radians.

  • MirrorFlag(): number

    returns Mirror flag Mirror flag : 0 = no mirroring. 1 = mirror axis perpendicular to text base line. 2 = mirror axis is text base line.

  • RotateFlag(): number

    returns Rotate internal text flag. Rotate internal text flag : 0 = text horizontal. 1 = text vertical.

  • If IsIncremental() returns False, gets coordinates of lower left corner of first character box. If IsIncremental() returns True, gets increments from X, Y, Z coordinates found in parent entity.

  • If IsIncremental() returns False, gets coordinates of lower left corner of first character box. If IsIncremental() returns True, gets increments from X, Y, Z coordinates found in parent entity.

IGESGraph_TextFontDef

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.

Constructors(1)

Static methods(2)

Instance methods(14)

  • Init(aFontCode: number, aFontName: TCollection_HAsciiString, aSupersededFont: number, aSupersededEntity: IGESGraph_TextFontDef, aScale: number, allASCIICodes: NCollection_HArray1_int, allNextCharX: NCollection_HArray1_int, allNextCharY: NCollection_HArray1_int, allPenMotions: NCollection_HArray1_int, allPenFlags: IGESBasic_HArray1OfHArray1OfInteger, allMovePenToX: IGESBasic_HArray1OfHArray1OfInteger, allMovePenToY: IGESBasic_HArray1OfHArray1OfInteger): void

    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.
    Parameters (12)
    • aFontCode
    • aFontName
    • aSupersededFont
    • aSupersededEntity
    • aScale
    • allASCIICodes
    • allNextCharX
    • allNextCharY
    • allPenMotions
    • allPenFlags
    • allMovePenToX
    • allMovePenToY
  • FontCode(): number

    returns the font code.

  • returns the font name.

  • True if this definition supersedes another TextFontDefinition Entity, False if it supersedes value.

  • returns the font number which this entity modifies.

  • returns the font entity which this entity modifies.

  • Scale(): number

    returns the number of grid units which equal one text height unit.

  • NbCharacters(): number

    returns the number of characters in this definition.

  • ASCIICode(Chnum: number): number

    returns the ASCII code of Chnum'th character. Exception OutOfRange is raised if Chnum <= 0 or Chnum > NbCharacters

    Parameters (1)
    • Chnum
  • NextCharOrigin(Chnum: number, NX: number, NY: number): { NX: number; NY: number }

    returns grid location of origin of character next to Chnum'th char. Exception OutOfRange is raised if Chnum <= 0 or Chnum > NbCharacters

    Parameters (3)
    • Chnum
    • NX
    • NY
    Returns

    A result object with fields:

    • NX: updated value from the call.
    • NY: updated value from the call.
  • NbPenMotions(Chnum: number): number

    returns number of pen motions for Chnum'th character. Exception OutOfRange is raised if Chnum <= 0 or Chnum > NbCharacters

    Parameters (1)
    • Chnum
  • IsPenUp(Chnum: number, Motionnum: number): boolean

    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

    Parameters (2)
    • Chnum
    • Motionnum
  • NextPenPosition(Chnum: number, Motionnum: number, IX: number, IY: number): { IX: number; IY: number }
    Parameters (4)
    • Chnum
    • Motionnum
    • IX
    • IY

IGESGraph_ToolColor

Tool to work on a Color. Called by various Modules (ReadWriteModule, GeneralModule, SpecificModule).

Constructors(1)

Instance methods(3)

IGESGraph_ToolDefinitionLevel

Tool to work on a DefinitionLevel. Called by various Modules (ReadWriteModule, GeneralModule, SpecificModule).

Constructors(1)

Instance methods(3)

IGESGraph_ToolDrawingSize

Tool to work on a DrawingSize. Called by various Modules (ReadWriteModule, GeneralModule, SpecificModule).

Constructors(1)

Instance methods(4)

IGESGraph_ToolDrawingUnits

Tool to work on a DrawingUnits. Called by various Modules (ReadWriteModule, GeneralModule, SpecificModule).

Constructors(1)

Instance methods(4)

IGESGraph_ToolHighLight

Tool to work on a HighLight. Called by various Modules (ReadWriteModule, GeneralModule, SpecificModule).

Constructors(1)

Instance methods(4)

IGESGraph_ToolIntercharacterSpacing

Tool to work on a IntercharacterSpacing. Called by various Modules (ReadWriteModule, GeneralModule, SpecificModule).

Constructors(1)

Instance methods(4)

IGESGraph_ToolLineFontDefPattern

Tool to work on a LineFontDefPattern. Called by various Modules (ReadWriteModule, GeneralModule, SpecificModule).

Constructors(1)

Instance methods(3)

IGESGraph_ToolLineFontDefTemplate

Tool to work on a LineFontDefTemplate. Called by various Modules (ReadWriteModule, GeneralModule, SpecificModule).

Constructors(1)

Instance methods(3)

IGESGraph_ToolLineFontPredefined

Tool to work on a LineFontPredefined. Called by various Modules (ReadWriteModule, GeneralModule, SpecificModule).

Constructors(1)

Instance methods(4)

IGESGraph_ToolNominalSize

Tool to work on a NominalSize. Called by various Modules (ReadWriteModule, GeneralModule, SpecificModule).

Constructors(1)

Instance methods(4)

IGESGraph_ToolPick

Tool to work on a Pick. Called by various Modules (ReadWriteModule, GeneralModule, SpecificModule).

Constructors(1)

Instance methods(4)

IGESGraph_ToolTextDisplayTemplate

Tool to work on a TextDisplayTemplate. Called by various Modules (ReadWriteModule, GeneralModule, SpecificModule).

Constructors(1)

Instance methods(3)

IGESGraph_ToolTextFontDef

Tool to work on a TextFontDef. Called by various Modules (ReadWriteModule, GeneralModule, SpecificModule).

Constructors(1)

Instance methods(3)

IGESGraph_ToolUniformRectGrid

Tool to work on a UniformRectGrid. Called by various Modules (ReadWriteModule, GeneralModule, SpecificModule).

Constructors(1)

Instance methods(4)

IGESGraph_UniformRectGrid

defines IGESUniformRectGrid, Type <406> Form <22> in package IGESGraph
Stores sufficient information for the creation of a uniform rectangular grid within a drawing

Constructors(1)

Static methods(2)

Instance methods(10)

  • Init(nbProps: number, finite: number, line: number, weighted: number, aGridPoint: gp_XY, aGridSpacing: gp_XY, pointsX: number, pointsY: number): void

    This method is used to set the fields of the class UniformRectGrid.

    • nbProps : Number of property values (NP = 9)
    • finite : Finite/Infinite grid flag
    • line : Line/Point grid flag
    • weighted : Weighted/Unweighted grid flag
    • aGridPoint : Point on the grid
    • aGridSpacing : Grid spacing
    • pointsX : No. of points/lines in X Direction
    • pointsY : No. of points/lines in Y Direction
    Parameters (8)
    • nbProps
    • finite
    • line
    • weighted
    • aGridPoint
    • aGridSpacing
    • pointsX
    • pointsY
  • returns the number of property values in <me>.

  • IsFinite(): boolean

    returns False if <me> is an infinite grid, True if <me> is a finite grid.

  • IsLine(): boolean

    returns False if <me> is a Point grid, True if <me> is a Line grid.

  • IsWeighted(): boolean

    returns False if <me> is a Weighted grid, True if <me> is not a Weighted grid.

  • returns coordinates of lower left corner, if <me> is a finite grid, coordinates of an arbitrary point, if <me> is an infinite grid.

  • returns the grid-spacing in drawing coordinates.

  • NbPointsX(): number

    returns the no. of points/lines in X direction (only applicable if IsFinite() = 1, i.e: a finite grid).

  • NbPointsY(): number

    returns the no. of points/lines in Y direction (only applicable if IsFinite() = 1, i.e: a finite grid).