OpenCascade.js
API ReferenceDataExchangeTKDEIGES

IGESBasic

OCCT package IGESBasic: IGESBasic, IGESBasic_AssocGroupType, IGESBasic_ExternalReferenceFile, IGESBasic_ExternalRefFile, and 38 more bound classes.

IGESBasic_AssocGroupType

defines AssocGroupType, Type <406> Form <23> in package IGESBasic Used to assign an unambiguous identification to a Group Associativity.

Constructors(1)

Static methods(2)

Instance methods(5)

  • Init(nbDataFields: number, aType: number, aName: TCollection_HAsciiString): void

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

    • nbDataFields : number of parameter data fields = 2
    • aType : type of attached associativity
    • aName : identifier of associativity of type AType
    Parameters (3)
    • nbDataFields
    • aType
    • aName
  • NbData(): number

    returns the number of parameter data fields, always = 2

  • AssocType(): number

    returns the type of attached associativity

  • returns identifier of instance of specified associativity

IGESBasic_ExternalReferenceFile

defines ExternalReferenceFile, Type <406> Form <12> in package IGESBasic References definitions residing in another file

Constructors(1)

Static methods(2)

Instance methods(4)

IGESBasic_ExternalRefFile

defines ExternalRefFile, Type <416> Form <1> in package IGESBasic Used when entire reference file is to be instanced

Constructors(1)

Static methods(2)

Instance methods(3)

IGESBasic_ExternalRefFileIndex

defines ExternalRefFileIndex, Type <402> Form <12> in package IGESBasic Contains a list of the symbolic names used by the referencing files and the DE pointers to the corresponding definitions within the referenced file

Constructors(1)

Static methods(2)

Instance methods(5)

IGESBasic_ExternalRefFileName

defines ExternalRefFileName, Type <416> Form <0-2> in package IGESBasic Used when single definition from the reference file is required or for external logical references where an entity in one file relates to an entity in another file

Constructors(1)

Static methods(2)

Instance methods(5)

IGESBasic_ExternalRefLibName

defines ExternalRefLibName, Type <416> Form <4> in package IGESBasic Used when it is assumed that a copy of the subfigure exists in native form in a library on the receiving system

Constructors(1)

Static methods(2)

Instance methods(4)

IGESBasic_ExternalRefName

defines ExternalRefName, Type <416> Form <3> in package IGESBasic Used when it is assumed that a copy of the subfigure exists in native form on the receiving system

Constructors(1)

Static methods(2)

Instance methods(3)

IGESBasic_GeneralModule

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

Constructors(1)

Static methods(2)

Instance methods(6)

  • Returns a DirChecker, specific for each type of Entity (identified by its Case Number) : this DirChecker defines constraints which must be respected by the DirectoryPart.

    Parameters (2)
    • CN
    • ent
  • OwnCheckCase(CN: number, ent: IGESData_IGESEntity, shares: Interface_ShareTool): { ach: Interface_Check; [Symbol.dispose](): void }

    Performs Specific Semantic Check for each type of Entity.

    Parameters (3)
    • CN
    • ent
    • shares
    Returns

    A result object with fields:

    • ach: owned by the returned envelope.
      Dispose the returned envelope to release owned Handle fields.
  • NewVoid(CN: number): { returnValue: boolean; entto: Standard_Transient; [Symbol.dispose](): void }

    Specific creation of a new void entity.

    Parameters (1)
    • CN
    Returns

    A result object with fields:

    • returnValue: the C++ return value
    • entto: owned by the returned envelope.
      Dispose the returned envelope to release owned Handle fields.
  • Copies parameters which are specific of each Type of Entity.

    Parameters (4)
    • CN
    • entfrom
    • entto
    • TC
  • CategoryNumber(CN: number, ent: Standard_Transient, shares: Interface_ShareTool): number

    Returns a category number which characterizes an entity Structure for Groups, Figures & Co Description for External Refs Auxiliary for other.

    Parameters (3)
    • CN
    • ent
    • shares

IGESBasic_Group

defines Group, Type <402> Form <1> in package IGESBasic The Group Associativity allows a collection of a set of entities to be maintained as a single, logical entity
Group, OrderedGroup, GroupWithoutBackP, OrderedGroupWithoutBackP share the same definition (class Group), form number changes
non Ordered, non WithoutBackP : form 1 non Ordered, WithoutBackP : form 7 Ordered, non WithoutBackP : form 14 Ordered, WithoutBackP : form 15

Constructors(2)

Static methods(2)

Instance methods(12)

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

    • allEntities : Used to store pointers to members of the Group.
    Parameters (1)
    • allEntities
  • SetOrdered(mode: boolean): void

    Sets a Group to be, or not to be Ordered (according mode).

    Parameters (1)
    • mode
  • SetWithoutBackP(mode: boolean): void

    Sets a Group to be, or not to be WithoutBackP.

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

    Returns True if <me> is Ordered.

  • IsWithoutBackP(): boolean

    Returns True if <me> is WithoutBackP.

  • SetUser(type_: number, form: number): void

    Enforce a new value for the type and form.

    Parameters (2)
    • type_
    • form
  • SetNb(nb: number): void

    Changes the count of item If greater, new items are null If lower, old items are lost.

    Parameters (1)
    • nb
  • NbEntities(): number

    returns the number of IGESEntities in the Group

  • Entity(Index: number): IGESData_IGESEntity

    returns the specific entity from the Group

    Parameters (1)
    • Index
  • Value(Index: number): Standard_Transient

    returns the specific entity from the Group

    Parameters (1)
    • Index
  • SetValue(Index: number, ent: IGESData_IGESEntity): void

    Sets a new value for item <Index>.

    Parameters (2)
    • Index
    • ent

IGESBasic_HArray1OfHArray1OfIGESEntity

Constructors(1)

Static methods(2)

Instance methods(6)

IGESBasic_Hierarchy

defines Hierarchy, Type <406> Form <10> in package IGESBasic Provides ability to control the hierarchy of each directory entry attribute.

Constructors(1)

Static methods(2)

Instance methods(9)

  • Init(nbPropVal: number, aLineFont: number, aView: number, anEntityLevel: number, aBlankStatus: number, aLineWt: number, aColorNum: number): void

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

    • nbPropVal : Number of Property values = 6
    • aLineFont : indicates the line font
    • aView : indicates the view
    • aEntityLevel : indicates the entity level
    • aBlankStatus : indicates the blank status
    • aLineWt : indicates the line weight
    • aColorNum : indicates the color num aLineFont, aView, aEntityLevel, aBlankStatus, aLineWt and aColorNum can take 0 or 1. 0 : The directory entry attribute will apply to entities physically subordinate to this entity. 1 : The directory entry attribute of this entity will not apply to physically subordinate entities.
    Parameters (7)
    • nbPropVal
    • aLineFont
    • aView
    • anEntityLevel
    • aBlankStatus
    • aLineWt
    • aColorNum
  • returns the number of property values, which should be 6

  • NewLineFont(): number

    returns the line font

  • NewView(): number

    returns the view

  • NewEntityLevel(): number

    returns the entity level

  • NewBlankStatus(): number

    returns the blank status

  • NewLineWeight(): number

    returns the line weight

  • NewColorNum(): number

    returns the color number

IGESBasic_Name

defines Name, Type <406> Form <15> in package IGESBasic Used to specify a user defined name

Constructors(1)

Static methods(2)

Instance methods(4)

IGESBasic_OrderedGroupWithoutBackP

defines OrderedGroupWithoutBackP, Type <402> Form <15> in package IGESBasic Allows a collection of a set of entities to be maintained as a single entity, but the group is ordered and there are no back pointers. It inherits from Group

Constructors(1)

Static methods(2)

Instance methods(1)

IGESBasic_Protocol

Description of Protocol for IGESBasic.

Constructors(1)

Static methods(2)

Instance methods(4)

  • NbResources(): number

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

  • 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

IGESBasic_ReadWriteModule

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

Constructors(1)

Static methods(2)

Instance methods(2)

IGESBasic_SingleParent

defines SingleParent, Type <402> Form <9> in package IGESBasic It defines a logical structure of one independent (parent) entity and one or more subordinate (children) entities

Constructors(1)

Static methods(2)

Instance methods(6)

IGESBasic_SingularSubfigure

defines SingularSubfigure, Type <408> Form <0> in package IGESBasic Defines the occurrence of a single instance of the defined Subfigure.

Constructors(1)

Static methods(2)

Instance methods(7)

  • Init(aSubfigureDef: IGESBasic_SubfigureDef, aTranslation: gp_XYZ, hasScale: boolean, aScale: number): void

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

    • aSubfigureDef : the Subfigure Definition entity
    • aTranslation : used to store the X,Y,Z coord
    • hasScale : Indicates the presence of scale factor
    • aScale : Used to store the scale factor
    Parameters (4)
    • aSubfigureDef
    • aTranslation
    • hasScale
    • aScale
  • returns the subfigure definition entity

  • returns the X, Y, Z coordinates

  • ScaleFactor(): number

    returns the scale factor if hasScaleFactor is False, returns 1.0 (default)

  • HasScaleFactor(): boolean

    returns a boolean indicating whether scale factor is present or not

  • returns the Translation after transformation

IGESBasic_SpecificModule

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

Constructors(1)

Static methods(2)

Instance methods(2)

IGESBasic_SubfigureDef

defines SubfigureDef, Type <308> Form <0> in package IGESBasic This Entity permits a single definition of a detail to be utilized in multiple instances in the creation of the whole picture

Constructors(1)

Static methods(2)

Instance methods(7)

IGESBasic_ToolAssocGroupType

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

Constructors(1)

Instance methods(4)

IGESBasic_ToolExternalReferenceFile

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

Constructors(1)

Instance methods(3)

IGESBasic_ToolExternalRefFile

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

Constructors(1)

Instance methods(3)

IGESBasic_ToolExternalRefFileIndex

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

Constructors(1)

Instance methods(3)

IGESBasic_ToolExternalRefFileName

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

Constructors(1)

Instance methods(3)

IGESBasic_ToolExternalRefLibName

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

Constructors(1)

Instance methods(3)

IGESBasic_ToolExternalRefName

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

Constructors(1)

Instance methods(3)

IGESBasic_ToolGroup

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

Constructors(1)

Instance methods(4)

IGESBasic_ToolGroupWithoutBackP

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

Constructors(1)

Instance methods(4)

IGESBasic_ToolHierarchy

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

Constructors(1)

Instance methods(4)

IGESBasic_ToolName

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

Constructors(1)

Instance methods(4)

IGESBasic_ToolOrderedGroup

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

Constructors(1)

Instance methods(4)

IGESBasic_ToolOrderedGroupWithoutBackP

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

Constructors(1)

Instance methods(4)

IGESBasic_ToolSingleParent

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

Constructors(1)

Instance methods(4)

IGESBasic_ToolSingularSubfigure

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

Constructors(1)

Instance methods(3)

IGESBasic_ToolSubfigureDef

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

Constructors(1)

Instance methods(3)