OpenCascade.js
API ReferenceDataExchangeTKDEIGES

IGESDraw

OCCT package IGESDraw: IGESDraw, IGESDraw_CircArraySubfigure, IGESDraw_ConnectPoint, IGESDraw_Drawing, and 29 more bound classes.

IGESDraw

This package contains the group of classes necessary for Structure Entities implied in Drawings and Structured Graphics (Sets for drawing, Drawings and Views).

Constructors(1)

Static methods(2)

IGESDraw_CircArraySubfigure

IGESData_IGESEntityStandard_Transient

Defines IGES Circular Array Subfigure Instance Entity, Type <414> Form Number <0> in package IGESDraw.
Used to produce copies of object called the base entity, arranging them around the edge of an imaginary circle whose center and radius are specified

Constructors(1)

Static methods(2)

Instance methods(14)

  • Init(aBase: IGESData_IGESEntity, aNumLocs: number, aCenter: gp_XYZ, aRadius: number, aStAngle: number, aDelAngle: number, aFlag: number, allNumPos: NCollection_HArray1_int): void

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

    • aBase : Base entity
    • aNumLocs : Total number of possible instance locations
    • aCenter : Coordinates of Center of imaginary circle
    • aRadius : Radius of imaginary circle
    • aStAngle : Start angle in radians
    • aDelAngle : Delta angle in radians
    • aFlag : DO-DON'T flag to control which portion to display
    • allNumPos : All position to be or not to be processed
    Parameters (8)
    • aBase
    • aNumLocs
    • aCenter
    • aRadius
    • aStAngle
    • aDelAngle
    • aFlag
    • allNumPos
  • BaseEntity(): IGESData_IGESEntity

    returns the base entity, copies of which are produced

  • NbLocations(): number

    returns total number of possible instance locations

  • CenterPoint(): gp_Pnt

    returns the center of the imaginary circle

  • TransformedCenterPoint(): gp_Pnt

    returns the Transformed center of the imaginary circle

  • CircleRadius(): number

    returns the radius of the imaginary circle

  • StartAngle(): number

    returns the start angle in radians

  • DeltaAngle(): number

    returns the delta angle in radians

  • ListCount(): number

    returns 0 if all elements to be displayed

  • DisplayFlag(): boolean

    returns True if (ListCount = 0) all elements are to be displayed

  • DoDontFlag(): boolean

    returns 0 if half or fewer of the elements of the array are defined returns 1 if half or more of the elements are defined

  • PositionNum(Index: number): boolean

    returns whether Index is to be processed (DO) or not to be processed(DON'T) if (ListCount = 0) return theDoDontFlag raises exception if Index <= 0 or Index > ListCount().

    Parameters (1)
    • Index
  • ListPosition(Index: number): number

    returns the Index'th value position raises exception if Index <= 0 or Index > ListCount().

    Parameters (1)
    • Index
  • DynamicType(): Standard_Type

IGESDraw_ConnectPoint

IGESData_IGESEntityStandard_Transient

defines IGESConnectPoint, Type <132> Form Number <0> in package IGESDraw
Connect Point Entity describes a point of connection for zero, one or more entities. Its referenced from Composite curve, or Network Subfigure Definition/Instance, or Flow Associative Instance, or it may stand alone.

Constructors(1)

Static methods(2)

Instance methods(19)

  • Init(aPoint: gp_XYZ, aDisplaySymbol: IGESData_IGESEntity, aTypeFlag: number, aFunctionFlag: number, aFunctionIdentifier: TCollection_HAsciiString, anIdentifierTemplate: IGESGraph_TextDisplayTemplate, aFunctionName: TCollection_HAsciiString, aFunctionTemplate: IGESGraph_TextDisplayTemplate, aPointIdentifier: number, aFunctionCode: number, aSwapFlag: number, anOwnerSubfigure: IGESData_IGESEntity): void

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

    • aPoint : A Coordinate point
    • aDisplaySymbol : Display symbol Geometry
    • aTypeFlag : Type of the connection
    • aFunctionFlag : Function flag for the connection
    • aFunctionIdentifier : Connection Point Function Identifier
    • anIdentifierTemplate : Connection Point Function Template
    • aFunctionName : Connection Point Function Name
    • aFunctionTemplate : Connection Point Function Template
    • aPointIdentifier : Unique Connect Point Identifier
    • aFunctionCode : Connect Point Function Code
    • aSwapFlag : Connect Point Swap Flag
    • anOwnerSubfigure : Pointer to the "Owner" Entity
    Parameters (12)
    • aPoint
    • aDisplaySymbol
    • aTypeFlag
    • aFunctionFlag
    • aFunctionIdentifier
    • anIdentifierTemplate
    • aFunctionName
    • aFunctionTemplate
    • aPointIdentifier
    • aFunctionCode
    • aSwapFlag
    • anOwnerSubfigure
  • Point(): gp_Pnt

    returns the coordinate of the connection point

  • TransformedPoint(): gp_Pnt

    returns the Transformed coordinate of the connection point

  • HasDisplaySymbol(): boolean

    returns True if Display symbol is specified else returns False

  • DisplaySymbol(): IGESData_IGESEntity

    if display symbol specified returns display symbol geometric entity else returns NULL Handle

  • TypeFlag(): number

    return value specifies a particular type of connection : Type Flag = 0 : Not Specified(default) 1 : Nonspecific logical point of connection 2 : Nonspecific physical point of connection 101 : Logical component pin 102 : Logical part connector 103 : Logical offpage connector 104 : Logical global signal connector 201 : Physical PWA surface mount pin 202 : Physical PWA blind pin 203 : Physical PWA thru-pin 5001-9999 : Implementor defined.

  • FunctionFlag(): number

    returns Function Code that specifies a particular function for the ECO576 connection : e.g., Function Flag = 0 : Unspecified(default) = 1 : Electrical Signal = 2 : Fluid flow Signal

  • FunctionIdentifier(): TCollection_HAsciiString

    return HAsciiString identifying Pin Number or Nozzle Label etc.

  • HasIdentifierTemplate(): boolean

    returns True if Text Display Template is specified for Identifier else returns False

  • IdentifierTemplate(): IGESGraph_TextDisplayTemplate

    if Text Display Template for the Function Identifier is defined, returns TestDisplayTemplate else returns NULL Handle

  • FunctionName(): TCollection_HAsciiString

    returns Connection Point Function Name

  • HasFunctionTemplate(): boolean

    returns True if Text Display Template is specified for Function Name else returns False

  • FunctionTemplate(): IGESGraph_TextDisplayTemplate

    if Text Display Template for the Function Name is defined, returns TestDisplayTemplate else returns NULL Handle

  • PointIdentifier(): number

    returns the Unique Connect Point Identifier

  • FunctionCode(): number

    returns the Connect Point Function Code

  • SwapFlag(): boolean

    return value = 0 : Connect point may be swapped(default) = 1 : Connect point may not be swapped

  • HasOwnerSubfigure(): boolean

    returns True if Network Subfigure Instance/Definition Entity is specified else returns False

  • OwnerSubfigure(): IGESData_IGESEntity

    returns "owner" Network Subfigure Instance Entity, or Network Subfigure Definition Entity, or NULL Handle.

  • DynamicType(): Standard_Type

IGESDraw_Drawing

IGESData_IGESEntityStandard_Transient

defines IGESDrawing, Type <404> Form <0> in package IGESDraw
Specifies a drawing as a collection of annotation entities defined in drawing space, and views which together constitute a single representation of a part

Constructors(1)

Static methods(2)

Instance methods(10)

  • Init(allViews: NCollection_HArray1_handle_IGESData_ViewKindEntity, allViewOrigins: NCollection_HArray1_gp_XY, allAnnotations: NCollection_HArray1_handle_IGESData_IGESEntity): void

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

    • allViews : Pointers to DEs of View entities
    • allViewOrigins : Origin coordinates of transformed Views
    • allAnnotations : Pointers to DEs of Annotation entities raises exception if Lengths of allViews and allViewOrigins are not same.
    Parameters (3)
    • allViews
    • allViewOrigins
    • allAnnotations
  • NbViews(): number

    returns the number of view pointers in <me>

  • ViewItem(ViewIndex: number): IGESData_ViewKindEntity

    returns the ViewKindEntity indicated by ViewIndex raises an exception if ViewIndex <= 0 or ViewIndex > NbViews().

    Parameters (1)
    • ViewIndex
  • ViewOrigin(TViewIndex: number): gp_Pnt2d

    returns the Drawing space coordinates of the origin of the Transformed view indicated by TViewIndex raises an exception if TViewIndex <= 0 or TViewIndex > NbViews().

    Parameters (1)
    • TViewIndex
  • NbAnnotations(): number

    returns the number of Annotation entities in <me>

  • Annotation(AnnotationIndex: number): IGESData_IGESEntity

    returns the Annotation entity in this Drawing, indicated by the AnnotationIndex raises an exception if AnnotationIndex <= 0 or AnnotationIndex > NbAnnotations().

    Parameters (1)
    • AnnotationIndex
  • ViewToDrawing(NumView: number, ViewCoords: gp_XYZ): gp_XY
    Parameters (2)
    • NumView
    • ViewCoords
  • DrawingUnit(value: number): { returnValue: boolean; value: number }

    Returns the Drawing Unit Value if it is specified (by a specific property entity) If not specified, returns False, and val as zero : unit to consider is then the model unit in GlobalSection.

    Parameters (1)
    • value
    Returns

    A result object with fields:

    • returnValue: the C++ return value
    • value: updated value from the call.
  • DrawingSize(X: number, Y: number): { returnValue: boolean; X: number; Y: number }

    Returns the Drawing Size if it is specified (by a specific property entity) If not specified, returns False, and X,Y as zero : unit to consider is then the model unit in GlobalSection.

    Parameters (2)
    • X
    • Y
    Returns

    A result object with fields:

    • returnValue: the C++ return value
    • X: updated value from the call.
    • Y: updated value from the call.
  • DynamicType(): Standard_Type

IGESDraw_DrawingWithRotation

IGESData_IGESEntityStandard_Transient

defines IGESDrawingWithRotation, Type <404> Form <1> in package IGESDraw
Permits rotation, in addition to transformation and scaling, between the view and drawing coordinate systems

Constructors(1)

Static methods(2)

Instance methods(11)

  • Init(allViews: NCollection_HArray1_handle_IGESData_ViewKindEntity, allViewOrigins: NCollection_HArray1_gp_XY, allOrientationAngles: NCollection_HArray1_double, allAnnotations: NCollection_HArray1_handle_IGESData_IGESEntity): void

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

    • allViews : Pointers to View entities
    • allViewOrigins : Origin coords of transformed views
    • allOrientationAngles : Orientation angles of transformed views
    • allAnnotations : Pointers to Annotation entities raises exception if Lengths of allViews, allViewOrigins and allOrientationAngles are not same.
    Parameters (4)
    • allViews
    • allViewOrigins
    • allOrientationAngles
    • allAnnotations
  • NbViews(): number

    returns the number of view pointers in <me>

  • ViewItem(Index: number): IGESData_ViewKindEntity

    returns the View entity indicated by Index raises an exception if Index <= 0 or Index > NbViews().

    Parameters (1)
    • Index
  • ViewOrigin(Index: number): gp_Pnt2d

    returns the Drawing space coordinates of the origin of the Transformed view indicated by Index raises an exception if Index <= 0 or Index > NbViews().

    Parameters (1)
    • Index
  • OrientationAngle(Index: number): number

    returns the Orientation angle for the Transformed view indicated by Index raises an exception if Index <= 0 or Index > NbViews().

    Parameters (1)
    • Index
  • NbAnnotations(): number

    returns the number of Annotation entities in <me>

  • Annotation(Index: number): IGESData_IGESEntity

    returns the Annotation entity in this Drawing, indicated by Index raises an exception if Index <= 0 or Index > NbAnnotations().

    Parameters (1)
    • Index
  • ViewToDrawing(NumView: number, ViewCoords: gp_XYZ): gp_XY
    Parameters (2)
    • NumView
    • ViewCoords
  • DrawingUnit(value: number): { returnValue: boolean; value: number }

    Returns the Drawing Unit Value if it is specified (by a specific property entity) If not specified, returns False, and val as zero : unit to consider is then the model unit in GlobalSection.

    Parameters (1)
    • value
    Returns

    A result object with fields:

    • returnValue: the C++ return value
    • value: updated value from the call.
  • DrawingSize(X: number, Y: number): { returnValue: boolean; X: number; Y: number }

    Returns the Drawing Size if it is specified (by a specific property entity) If not specified, returns False, and X,Y as zero : unit to consider is then the model unit in GlobalSection.

    Parameters (2)
    • X
    • Y
    Returns

    A result object with fields:

    • returnValue: the C++ return value
    • X: updated value from the call.
    • Y: updated value from the call.
  • DynamicType(): Standard_Type

IGESDraw_GeneralModule

IGESData_GeneralModuleInterface_GeneralModuleStandard_Transient

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

Constructors(1)

Static methods(2)

Instance methods(8)

IGESDraw_LabelDisplay

IGESData_LabelDisplayEntityIGESData_IGESEntityStandard_Transient

defines IGESLabelDisplay, Type <402> Form <5> in package IGESDraw
Permits one or more displays for the entity labels of an entity

Constructors(1)

Static methods(2)

Instance methods(9)

  • Init(allViews: NCollection_HArray1_handle_IGESData_ViewKindEntity, allTextLocations: NCollection_HArray1_gp_XYZ, allLeaderEntities: NCollection_HArray1_handle_IGESDimen_LeaderArrow, allLabelLevels: NCollection_HArray1_int, allDisplayedEntities: NCollection_HArray1_handle_IGESData_IGESEntity): void

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

    • allViews : Pointers to View Entities
    • allTextLocations : Coordinates of text locations in the views
    • allLeaderEntities : Pointers to Leader Entities in the views
    • allLabelLevels : Entity label level numbers in the views
    • allDisplayedEntities : Pointers to the entities being displayed raises exception if Lengths of allViews, allTextLocations, allLeaderEntities, allLabelLevels and allDisplayedEntities are not same.
    Parameters (5)
    • allViews
    • allTextLocations
    • allLeaderEntities
    • allLabelLevels
    • allDisplayedEntities
  • NbLabels(): number

    returns the number of label placements in <me>

  • ViewItem(ViewIndex: number): IGESData_ViewKindEntity

    returns the View entity indicated by ViewIndex raises an exception if ViewIndex <= 0 or ViewIndex > NbLabels().

    Parameters (1)
    • ViewIndex
  • TextLocation(ViewIndex: number): gp_Pnt

    returns the 3d-Point coordinates of the text location, in the view indicated by ViewIndex raises an exception if ViewIndex <= 0 or ViewIndex > NbLabels().

    Parameters (1)
    • ViewIndex
  • LeaderEntity(ViewIndex: number): IGESDimen_LeaderArrow

    returns the Leader entity in the view indicated by ViewIndex raises an exception if ViewIndex <= 0 or ViewIndex > NbLabels().

    Parameters (1)
    • ViewIndex
  • LabelLevel(ViewIndex: number): number

    returns the Entity label level number in the view indicated by ViewIndex raises an exception if ViewIndex <= 0 or ViewIndex > NbLabels().

    Parameters (1)
    • ViewIndex
  • DisplayedEntity(EntityIndex: number): IGESData_IGESEntity

    returns the entity indicated by EntityIndex raises an exception if EntityIndex <= 0 or EntityIndex > NbLabels().

    Parameters (1)
    • EntityIndex
  • TransformedTextLocation(ViewIndex: number): gp_Pnt

    returns the transformed 3d-Point coordinates of the text location, in the view indicated by ViewIndex raises an exception if ViewIndex <= 0 or ViewIndex > NbLabels().

    Parameters (1)
    • ViewIndex
  • DynamicType(): Standard_Type

IGESDraw_NetworkSubfigure

IGESData_IGESEntityStandard_Transient

defines IGES Network Subfigure Instance Entity, Type <420> Form Number <0> in package IGESDraw
Used to specify each instance of Network Subfigure Definition Entity (Type 320, Form 0).

Constructors(1)

Static methods(2)

Instance methods(12)

IGESDraw_NetworkSubfigureDef

IGESData_IGESEntityStandard_Transient

defines IGESNetworkSubfigureDef, Type <320> Form Number <0> in package IGESDraw
This class differs from the ordinary subfigure definition in that it defines a specialized subfigure, one whose instances may participate in networks.
The Number of associated(child) Connect Point Entities in the Network Subfigure Instance must match the number in the Network Subfigure Definition, their order must be identical, and any unused points of connection in the instance must be indicated by a null(zero) pointer.

Constructors(1)

Static methods(2)

Instance methods(13)

  • Init(aDepth: number, aName: TCollection_HAsciiString, allEntities: NCollection_HArray1_handle_IGESData_IGESEntity, aTypeFlag: number, aDesignator: TCollection_HAsciiString, aTemplate: IGESGraph_TextDisplayTemplate, allPointEntities: NCollection_HArray1_handle_IGESDraw_ConnectPoint): void

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

    • aDepth : Depth of Subfigure (indicating the amount of nesting)
    • aName : Subfigure Name
    • allEntities : Associated subfigures Entities exclusive of primary reference designator and Control Points.
    • aTypeFlag : Type flag determines which Entity belongs in which design (Logical design or Physical design)
    • aDesignator : Designator HAsciiString and its Template
    • allPointEntities : Associated Connect Point Entities
    Parameters (7)
    • aDepth
    • aName
    • allEntities
    • aTypeFlag
    • aDesignator
    • aTemplate
    • allPointEntities
  • Depth(): number

    returns Depth of Subfigure(indication the amount of nesting) Note : The Depth is inclusive of both Network Subfigure Definition Entity and the Ordinary Subfigure Definition Entity. Thus, the two may be nested.

  • Name(): TCollection_HAsciiString

    returns the Subfigure Name

  • NbEntities(): number

    returns Number of Associated(child) entries in subfigure exclusive of primary reference designator and Control Points

  • Entity(Index: number): IGESData_IGESEntity

    returns the Index'th IGESEntity in subfigure exclusive of primary reference designator and Control Points raises exception if Index <=0 or Index > NbEntities()

    Parameters (1)
    • Index
  • TypeFlag(): number

    return value = 0 : Not Specified = 1 : Logical design = 2 : Physical design

  • Designator(): TCollection_HAsciiString

    returns Primary Reference Designator

  • HasDesignatorTemplate(): boolean

    returns True if Text Display Template is specified for primary designator else returns False

  • DesignatorTemplate(): IGESGraph_TextDisplayTemplate

    if Text Display Template specified then return TextDisplayTemplate else return NULL Handle

  • NbPointEntities(): number

    returns the Number Of Associated(child) Connect Point Entities

  • HasPointEntity(Index: number): boolean

    returns True is Index'th Associated Connect Point Entity is present else returns False raises exception if Index is out of bound

    Parameters (1)
    • Index
  • PointEntity(Index: number): IGESDraw_ConnectPoint

    returns the Index'th Associated Connect Point Entity raises exception if Index <= 0 or Index > NbPointEntities()

    Parameters (1)
    • Index
  • DynamicType(): Standard_Type

IGESDraw_PerspectiveView

IGESData_ViewKindEntityIGESData_IGESEntityStandard_Transient

defines IGESPerspectiveView, Type <410> Form <1> in package IGESDraw
Supports a perspective view. Any geometric projection is defined by a view plane and the projectors that pass through the view plane. Projectors can be visualized as rays of light that form an image by passing through the viewed object and striking the view plane. The projectors are defined via a point called the Centre-of-Projection or the eye-point. A perspective view is formed by all projectors that emanate from the Centre-of-Projection and pass through the view plane.

Constructors(1)

Static methods(2)

Instance methods(19)

  • Init(aViewNumber: number, aScaleFactor: number, aViewNormalVector: gp_XYZ, aViewReferencePoint: gp_XYZ, aCenterOfProjection: gp_XYZ, aViewUpVector: gp_XYZ, aViewPlaneDistance: number, aTopLeft: gp_XY, aBottomRight: gp_XY, aDepthClip: number, aBackPlaneDistance: number, aFrontPlaneDistance: number): void

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

    • aViewNumber : The desired view
    • aScaleFactor : Scale factor
    • aViewNormalVector : View plane normal vector (model space)
    • aViewReferencePoint : View reference point (model space)
    • aCenterOfProjection : Center Of Projection (model space)
    • aViewUpVector : View up vector (model space)
    • aViewPlaneDistance : View plane distance (model space)
    • aTopLeft : Top-left point of clipping window
    • aBottomRight : Bottom-right point of clipping window
    • aDepthClip : Depth clipping indicator
    • aBackPlaneDistance : Distance of back clipping plane
    • aFrontPlaneDistance : Distance of front clipping plane
    Parameters (12)
    • aViewNumber
    • aScaleFactor
    • aViewNormalVector
    • aViewReferencePoint
    • aCenterOfProjection
    • aViewUpVector
    • aViewPlaneDistance
    • aTopLeft
    • aBottomRight
    • aDepthClip
    • aBackPlaneDistance
    • aFrontPlaneDistance
  • IsSingle(): boolean

    Returns True (for a single view).

  • NbViews(): number

    Returns 1 (single view).

  • ViewItem(num: number): IGESData_ViewKindEntity

    For a single view, returns <me> whatever <num>.

    Parameters (1)
    • num
  • ViewNumber(): number

    returns the view number associated with <me>

  • ScaleFactor(): number

    returns the scale factor associated with <me>

  • ViewNormalVector(): gp_Vec

    returns the View plane normal vector (model space)

  • ViewReferencePoint(): gp_Pnt

    returns the View reference point (model space)

  • CenterOfProjection(): gp_Pnt

    returns the Center Of Projection (model space)

  • ViewUpVector(): gp_Vec

    returns the View up vector (model space)

  • ViewPlaneDistance(): number

    returns the View plane distance (model space)

  • TopLeft(): gp_Pnt2d

    returns the top left point of the clipping window

  • BottomRight(): gp_Pnt2d

    returns the bottom right point of the clipping window

  • DepthClip(): number

    returns the Depth clipping indicator 0 = No depth clipping 1 = Back clipping plane ON 2 = Front clipping plane ON 3 = Back and front clipping planes ON

  • BackPlaneDistance(): number

    returns the View coordinate denoting the location of the back clipping plane

  • FrontPlaneDistance(): number

    returns the View coordinate denoting the location of the front clipping plane

  • ViewMatrix(): IGESData_TransfEntity

    returns the Transformation Matrix

  • ModelToView(coords: gp_XYZ): gp_XYZ

    returns XYX from the Model space to the View space by applying the View Matrix

    Parameters (1)
    • coords
  • DynamicType(): Standard_Type

IGESDraw_Planar

IGESData_IGESEntityStandard_Transient

defines IGESPlanar, Type <402> Form <16> in package IGESDraw
Indicates that a collection of entities is coplanar.The entities may be geometric, annotative, and/or structural.

Constructors(1)

Static methods(2)

Instance methods(7)

  • Init(nbMats: number, aTransformationMatrix: IGESGeom_TransformationMatrix, allEntities: NCollection_HArray1_handle_IGESData_IGESEntity): void

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

    • nbMats : Number of Transformation matrices
    • aTransformationMatrix : Pointer to the Transformation matrix
    • allEntities : Pointers to the entities specified
    Parameters (3)
    • nbMats
    • aTransformationMatrix
    • allEntities
  • NbMatrices(): number

    returns the number of Transformation matrices in <me>

  • NbEntities(): number

    returns the number of Entities in the plane pointed to by this associativity

  • IsIdentityMatrix(): boolean

    returns True if TransformationMatrix is Identity Matrix, i.e:- No Matrix defined.

  • TransformMatrix(): IGESGeom_TransformationMatrix

    returns the Transformation matrix moving data from the XY plane into space or zero

  • Entity(EntityIndex: number): IGESData_IGESEntity

    returns the Entity on the specified plane, indicated by EntityIndex raises an exception if EntityIndex <= 0 or EntityIndex > NbEntities()

    Parameters (1)
    • EntityIndex
  • DynamicType(): Standard_Type

IGESDraw_Protocol

IGESData_ProtocolInterface_ProtocolStandard_Transient

Description of Protocol for IGESDraw.

Constructors(1)

Static methods(2)

Instance methods(4)

  • NbResources(): number

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

  • Resource(num: number): Interface_Protocol

    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
  • DynamicType(): Standard_Type

IGESDraw_ReadWriteModule

IGESData_ReadWriteModuleInterface_ReaderModuleStandard_Transient

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

Constructors(1)

Static methods(2)

Instance methods(2)

IGESDraw_RectArraySubfigure

IGESData_IGESEntityStandard_Transient

Defines IGES Rectangular Array Subfigure Instance Entity, Type <412> Form Number <0> in package IGESDraw Used to produce copies of object called the base entity, arranging them in equally spaced rows and columns.

Constructors(1)

Static methods(2)

Instance methods(16)

  • Init(aBase: IGESData_IGESEntity, aScale: number, aCorner: gp_XYZ, nbCols: number, nbRows: number, hDisp: number, vtDisp: number, rotationAngle: number, doDont: number, allNumPos: NCollection_HArray1_int): void

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

    • aBase : a base entity which is replicated
    • aScale : Scale Factor
    • aCorner : lower left hand corner for the entire array
    • nbCols : Number of columns of the array
    • nbRows : Number of rows of the array
    • hDisp : Column separations
    • vtDisp : Row separation
    • rotationAngle : Rotation angle specified in radians
    • allDont : DO-DON'T flag to control which portion to display
    • allNumPos : List of positions to be or not to be displayed
    Parameters (10)
    • aBase
    • aScale
    • aCorner
    • nbCols
    • nbRows
    • hDisp
    • vtDisp
    • rotationAngle
    • doDont
    • allNumPos
  • BaseEntity(): IGESData_IGESEntity

    returns the base entity, copies of which are produced

  • ScaleFactor(): number

    returns the scale factor

  • LowerLeftCorner(): gp_Pnt

    returns coordinates of lower left hand corner for the entire array

  • TransformedLowerLeftCorner(): gp_Pnt

    returns Transformed coordinates of lower left corner for the array

  • NbColumns(): number

    returns number of columns in the array

  • NbRows(): number

    returns number of rows in the array

  • ColumnSeparation(): number

    returns horizontal distance between columns

  • RowSeparation(): number

    returns vertical distance between rows

  • RotationAngle(): number

    returns rotation angle in radians

  • DisplayFlag(): boolean

    returns True if (ListCount = 0) i.e., all elements to be displayed

  • ListCount(): number

    returns 0 if all replicated entities to be displayed

  • DoDontFlag(): boolean

    returns 0 if half or fewer of the elements of the array are defined 1 if half or more of the elements are defined

  • PositionNum(Index: number): boolean

    returns whether Index is to be processed (DO) or not to be processed(DON'T) if (ListCount = 0) return theDoDontFlag

    Parameters (1)
    • Index
  • ListPosition(Index: number): number

    returns the Index'th value position raises exception if Index <= 0 or Index > ListCount()

    Parameters (1)
    • Index
  • DynamicType(): Standard_Type

IGESDraw_SegmentedViewsVisible

IGESData_ViewKindEntityIGESData_IGESEntityStandard_Transient

defines IGESSegmentedViewsVisible, Type <402> Form <19> in package IGESDraw
Permits the association of display parameters with the segments of curves in a given view

Constructors(1)

Static methods(2)

Instance methods(15)

  • Init(allViews: NCollection_HArray1_handle_IGESData_ViewKindEntity, allBreakpointParameters: NCollection_HArray1_double, allDisplayFlags: NCollection_HArray1_int, allColorValues: NCollection_HArray1_int, allColorDefinitions: NCollection_HArray1_handle_IGESGraph_Color, allLineFontValues: NCollection_HArray1_int, allLineFontDefinitions: NCollection_HArray1_handle_IGESData_LineFontEntity, allLineWeights: NCollection_HArray1_int): void

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

    • allViews : Pointers to View Entities
    • allBreakpointParameters : Parameters of breakpoints
    • allDisplayFlags : Display flags
    • allColorValues : Color Values
    • allColorDefinitions : Color Definitions
    • allLineFontValues : LineFont values
    • allLineFontDefinitions : LineFont Definitions
    • allLineWeights : Line weights raises exception if Lengths of allViews, allBreakpointParameters, allDisplayFlags, allColorValues, allColorDefinitions, allLineFontValues, allLineFontDefinitions and allLineWeights are not same.
    Parameters (8)
    • allViews
    • allBreakpointParameters
    • allDisplayFlags
    • allColorValues
    • allColorDefinitions
    • allLineFontValues
    • allLineFontDefinitions
    • allLineWeights
  • IsSingle(): boolean

    Returns False (for a complex view).

  • NbViews(): number

    Returns the count of Views referenced by <me> (inherited).

  • NbSegmentBlocks(): number

    returns the number of view/segment blocks in <me> Similar to NbViews but has a more general significance

  • ViewItem(num: number): IGESData_ViewKindEntity

    returns the View entity indicated by ViewIndex raises an exception if ViewIndex <= 0 or ViewIndex > NbSegmentBlocks()

    Parameters (1)
    • num
  • BreakpointParameter(BreakpointIndex: number): number

    returns the parameter of the breakpoint indicated by BreakpointIndex raises an exception if BreakpointIndex <= 0 or BreakpointIndex > NbSegmentBlocks().

    Parameters (1)
    • BreakpointIndex
  • DisplayFlag(FlagIndex: number): number

    returns the Display flag indicated by FlagIndex raises an exception if FlagIndex <= 0 or FlagIndex > NbSegmentBlocks().

    Parameters (1)
    • FlagIndex
  • IsColorDefinition(ColorIndex: number): boolean

    returns True if the ColorIndex'th value of the "theColorDefinitions" field of <me> is a pointer raises an exception if ColorIndex <= 0 or ColorIndex > NbSegmentBlocks().

    Parameters (1)
    • ColorIndex
  • ColorValue(ColorIndex: number): number

    returns the Color value indicated by ColorIndex raises an exception if ColorIndex <= 0 or ColorIndex > NbSegmentBlocks().

    Parameters (1)
    • ColorIndex
  • ColorDefinition(ColorIndex: number): IGESGraph_Color

    returns the Color definition entity indicated by ColorIndex raises an exception if ColorIndex <= 0 or ColorIndex > NbSegmentBlocks().

    Parameters (1)
    • ColorIndex
  • IsFontDefinition(FontIndex: number): boolean

    returns True if the FontIndex'th value of the "theLineFontDefinitions" field of <me> is a pointer raises an exception if FontIndex <= 0 or FontIndex > NbSegmentBlocks().

    Parameters (1)
    • FontIndex
  • LineFontValue(FontIndex: number): number

    returns the LineFont value indicated by FontIndex raises an exception if FontIndex <= 0 or FontIndex > NbSegmentBlocks().

    Parameters (1)
    • FontIndex
  • LineFontDefinition(FontIndex: number): IGESData_LineFontEntity

    returns the LineFont definition entity indicated by FontIndex raises an exception if FontIndex <= 0 or FontIndex > NbSegmentBlocks().

    Parameters (1)
    • FontIndex
  • LineWeightItem(WeightIndex: number): number

    returns the LineWeight value indicated by WeightIndex raises an exception if WeightIndex <= 0 or WeightIndex > NbSegmentBlocks().

    Parameters (1)
    • WeightIndex
  • DynamicType(): Standard_Type

IGESDraw_SpecificModule

IGESData_SpecificModuleStandard_Transient

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

Constructors(1)

Static methods(2)

Instance methods(2)

IGESDraw_ToolCircArraySubfigure

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

Constructors(1)

Instance methods(3)

IGESDraw_ToolConnectPoint

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

Constructors(1)

Instance methods(3)

IGESDraw_ToolDrawing

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

Constructors(1)

Instance methods(4)

IGESDraw_ToolDrawingWithRotation

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

Constructors(1)

Instance methods(4)

IGESDraw_ToolLabelDisplay

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

Constructors(1)

Instance methods(3)

IGESDraw_ToolNetworkSubfigure

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

Constructors(1)

Instance methods(3)

IGESDraw_ToolNetworkSubfigureDef

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

Constructors(1)

Instance methods(3)

IGESDraw_ToolPerspectiveView

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

Constructors(1)

Instance methods(3)

IGESDraw_ToolPlanar

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

Constructors(1)

Instance methods(4)

IGESDraw_ToolRectArraySubfigure

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

Constructors(1)

Instance methods(3)

IGESDraw_ToolSegmentedViewsVisible

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

Constructors(1)

Instance methods(3)

IGESDraw_ToolView

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

Constructors(1)

Instance methods(3)

IGESDraw_ToolViewsVisible

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

Constructors(1)

Instance methods(6)

IGESDraw_ToolViewsVisibleWithAttr

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

Constructors(1)

Instance methods(6)

IGESDraw_View

IGESData_ViewKindEntityIGESData_IGESEntityStandard_Transient

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.

Constructors(1)

Static methods(2)

Instance methods(21)

IGESDraw_ViewsVisible

IGESData_ViewKindEntityIGESData_IGESEntityStandard_Transient

Defines IGESViewsVisible, Type <402>, Form <3> in package IGESDraw.
If an entity is to be displayed in more than one views, this class instance is used, which contains the Visible views and the associated entity Displays.

Constructors(1)

Static methods(2)

Instance methods(8)

IGESDraw_ViewsVisibleWithAttr

IGESData_ViewKindEntityIGESData_IGESEntityStandard_Transient

defines IGESViewsVisibleWithAttr, Type <402>, Form <4> in package IGESDraw
This class is extension of Class ViewsVisible. It is used for those entities that are visible in multiple views, but must have a different line font, color number, or line weight in each view.

Constructors(1)

Static methods(2)

Instance methods(15)

  • Init(allViewEntities: NCollection_HArray1_handle_IGESData_ViewKindEntity, allLineFonts: NCollection_HArray1_int, allLineDefinitions: NCollection_HArray1_handle_IGESData_LineFontEntity, allColorValues: NCollection_HArray1_int, allColorDefinitions: NCollection_HArray1_handle_IGESGraph_Color, allLineWeights: NCollection_HArray1_int, allDisplayEntities: NCollection_HArray1_handle_IGESData_IGESEntity): void

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

    • allViewEntities : All View kind entities
    • allLineFonts : All Line Font values or zero(0)
    • allLineDefinitions : Line Font Definition (if Line Font value = 0)
    • allColorValues : All Color values
    • allColorDefinitions : All Color Definition Entities
    • allLineWeights : All Line Weight values
    • allDisplayEntities : Entities which are member of this associativity raises exception if Lengths of allViewEntities, allLineFonts, allColorValues,allColorDefinitions, allLineWeights are not same
    Parameters (7)
    • allViewEntities
    • allLineFonts
    • allLineDefinitions
    • allColorValues
    • allColorDefinitions
    • allLineWeights
    • allDisplayEntities
  • InitImplied(allDisplayEntity: NCollection_HArray1_handle_IGESData_IGESEntity): void

    Changes only the list of Displayed Entities (Null allowed).

    Parameters (1)
    • allDisplayEntity
  • IsSingle(): boolean

    Returns False (for a complex view).

  • NbViews(): number

    returns the number of Views containing the view visible, line font, color number, and line weight information

  • NbDisplayedEntities(): number

    returns the number of entities which have this particular set of display characteristic, or zero if no Entities specified

  • ViewItem(num: number): IGESData_ViewKindEntity

    returns the Index'th ViewKindEntity entity raises exception if Index <= 0 or Index > NbViews()

    Parameters (1)
    • num
  • LineFontValue(Index: number): number

    returns the Index'th Line font value or zero raises exception if Index <= 0 or Index > NbViews()

    Parameters (1)
    • Index
  • IsFontDefinition(Index: number): boolean

    returns True if the Index'th Line Font Definition is specified else returns False raises exception if Index <= 0 or Index > NbViews()

    Parameters (1)
    • Index
  • FontDefinition(Index: number): IGESData_LineFontEntity

    returns the Index'th Line Font Definition Entity or NULL(0) raises exception if Index <= 0 or Index > NbViews()

    Parameters (1)
    • Index
  • ColorValue(Index: number): number

    returns the Index'th Color number value raises exception if Index <= 0 or Index > NbViews()

    Parameters (1)
    • Index
  • IsColorDefinition(Index: number): boolean

    returns True if Index'th Color Definition is specified else returns False raises exception if Index <= 0 or Index > NbViews()

    Parameters (1)
    • Index
  • ColorDefinition(Index: number): IGESGraph_Color

    returns the Index'th Color Definition Entity raises exception if Index <= 0 or Index > NbViews()

    Parameters (1)
    • Index
  • LineWeightItem(Index: number): number

    returns the Index'th Color Line Weight raises exception if Index <= 0 or Index > NbViews()

    Parameters (1)
    • Index
  • DisplayedEntity(Index: number): IGESData_IGESEntity

    returns Index'th Display entity with this particular characteristics raises exception if Index <= 0 or Index > NbEntities()

    Parameters (1)
    • Index
  • DynamicType(): Standard_Type

IGESDimen

OCCT package IGESDimen: IGESDimen, IGESDimen_AngularDimension, IGESDimen_BasicDimension, IGESDimen_CenterLine, and 47 more bound classes.

IGESGeom

OCCT package IGESGeom: IGESGeom, IGESGeom_Boundary, IGESGeom_BoundedSurface, IGESGeom_BSplineCurve, and 47 more bound classes.