IGESSelect
OCCT package IGESSelect: IGESSelect, IGESSelect_Activator, IGESSelect_AddFileComment, IGESSelect_AddGroup, and 42 more bound classes.
IGESSelect
This package defines the library of the most used tools for IGES Files : Selections & Modifiers specific to the IGES norm, and the most needed converters.
Constructors(1)
IGESSelect_Activator
Performs Actions specific to IGESSelect, i.e. creation of IGES Selections and Dispatches, plus dumping specific to IGES.
Constructors(1)
Static methods(2)
- get_type_name(): string
Instance methods(3)
- Do(number_: number, pilot: IFSelect_SessionPilot): IFSelect_ReturnStatus
Executes a Command Line for
IGESSelect.Parameters (2)number_pilot
- Help(number_: number): string
Sends a short help message for
IGESSelectcommands.Parameters (1)number_
IGESSelect_AddFileComment
This class allows to add comment lines on writing an IGES File These lines are added to Start Section, instead of the only one blank line written by default.
Constructors(1)
Creates a new empty AddFileComment. Use AddLine to complete it.
Static methods(2)
- get_type_name(): string
Instance methods(9)
- Clear(): void
Clears the list of file comment lines already stored.
- AddLine(line: string): void
Adds a line for file comment Remark: Lines are limited to 72 useful chars. A line of more than 72 chars will be split into several ones of 72 max each.
Parameters (1)line
Adds a list of lines for file comment Each of them must comply with demand of AddLine.
Parameters (1)lines
- NbLines(): number
Returns the count of stored lines.
- Line(num: number): string
Returns a stored line given its rank.
Parameters (1)num
Returns the complete list of lines in once.
- Perform(ctx: IFSelect_ContextWrite, writer: IGESData_IGESWriter): void
Sends the comment lines to the file (Start Section).
Parameters (2)ctxwriter—Mutated in place; read the updated value from this argument after the call.
Returns specific Label, which is "Add <nn> Comment Lines (Start Section)".
IGESSelect_AddGroup
Adds a Group to contain the entities designated by the Selection. If no Selection is given, nothing is done.
Constructors(1)
Creates an AddGroup.
Static methods(2)
- get_type_name(): string
Instance methods(1)
IGESSelect_AutoCorrect
Does the absolutely effective corrections on IGES Entity. That is to say : regarding the norm in details, some values have mandatory values, or set of values with constraints. When such values/constraints are univoque, they can be forced. Also nullifies items of Directory Part, Associativities, and Properties, which are not (or not longer) in <target> Model.
Works by calling a BasicEditor from IGESData Works with the specific IGES Services : DirChecker which allows to correct data in "Directory Part" of Entities (such as required values for status, or references to be null), and the specific IGES service OwnCorrect, which is specialised for each type of entity.
Remark : this does not comprise the computation of use flag or subordinate status according references, which is made by the ModelModifier class ComputeStatus.
The Input Selection, when present, designates the entities to be corrected. If it is not present, all the entities of the model are corrected.
Constructors(1)
Creates an AutoCorrect.
Static methods(2)
- get_type_name(): string
Instance methods(1)
IGESSelect_ChangeLevelList
Changes Level List (in directory part) to a new single value Only entities attached to a LevelListEntity are considered If OldNumber is defined, only entities whose LevelList contains its Value are processed. Else all LevelLists are.
Remark : this concerns the Directory Part only. The Level List Entities themselves (their content) are not affected.
If NewNumber is defined (positive or zero), it gives the new value for Level Number. Else, the first value of the LevelList is set as new LevelNumber
Constructors(1)
Creates a ChangeLevelList, not yet defined (see SetOldNumber and SetNewNumber).
Static methods(2)
- get_type_name(): string
Instance methods(3)
- HasNewNumber(): boolean
Returns True if NewNumber is defined : then, it gives the new value for Level Number. Else, the first value of the LevelList is used as new Level Number.
Returns a text which begins by "Changes Level Lists containing <old>", or "Changes all Level Lists in D.E.", and ends by " to Number <new>" or " to Number = first value in List".
IGESSelect_ChangeLevelNumber
Changes Level Number (as null or single) to a new single value Entities attached to a LevelListEntity are ignored Entities considered can be, either all Entities but those attached to a LevelListEntity, or Entities attached to a specific Level Number (0 for not defined).
Remark : this concerns the Directory Part only. The Level List Entities themselves (their content) are not affected.
Constructors(1)
Creates a ChangeLevelNumber, not yet defined (see SetOldNumber and SetNewNumber).
Static methods(2)
- get_type_name(): string
Instance methods(2)
Returns a text which is "Changes Level Number <old> to <new>" , or "Changes all Levels Numbers positive and zero to <new>".
IGESSelect_ComputeStatus
Computes Status of IGES Entities for a whole IGESModel. This concerns SubordinateStatus and UseFlag, which must have some definite values according the way they are referenced. (see definitions of Logical use, Physical use, etc...).
Works by calling a BasicEditor from IGESData. Works on the whole produced (target) model, because computation is global.
Constructors(1)
Creates an ComputeStatus, which uses the system Date.
Static methods(2)
- get_type_name(): string
Instance methods(1)
IGESSelect_CounterOfLevelNumber
This class gives information about Level Number. It counts entities according level number, considering also the multiple level (see the class LevelList) for which an entity is attached to each of the listed levels.
Data are available, as level number, or as their alphanumeric counterparts ("LEVEL nnnnnnn", " NO LEVEL", " LEVEL LIST")
Constructors(1)
- constructor(withmap?: boolean, withlist?: boolean): IGESSelect_CounterOfLevelNumber
Creates a CounterOfLevelNumber, clear, ready to work <withmap> and <withlist> are transmitted to SignCounter.
Parameters (2)withmapwithlist
Static methods(2)
- get_type_name(): string
Instance methods(8)
- Clear(): void
Resets already memorized information : also numeric data.
- AddSign(ent: Standard_Transient, model: Interface_InterfaceModel): void
Adds an entity by considering its lrvrl number(s) A level is added both in numeric and alphanumeric form, i.e. LevelList gives "LEVEL LIST", others (no level or positive level) displays level number on 7 digits (C : %7d) Remark : an entity attached to a Level List is added for " LEVEL LIST", and for each of its constituent levels.
Parameters (2)entmodel
- AddLevel(ent: Standard_Transient, level: number): void
The internal action to record a new level number, positive, null (no level) or negative (level list).
Parameters (2)entlevel
- HighestLevel(): number
Returns the highest value found for a level number.
- NbTimesLevel(level: number): number
Returns the number of times a level is used, 0 if it has not been recorded at all <level> = 0 counts entities attached to no level <level> < 0 counts entities attached to a LevelList.
Parameters (1)level
Returns the ordered list of used positive Level numbers.
- Sign(ent: Standard_Transient, model: Interface_InterfaceModel): TCollection_HAsciiString
Determines and returns the value of the signature for an entity as an HAsciiString. Redefined, gives the same result as AddSign, see this method ("LEVEL LIST" or "nnnnnnn").
Parameters (2)entmodel
IGESSelect_DispPerDrawing
This type of dispatch defines sets of entities attached to distinct drawings. This information is taken from attached views which appear in the Directory Part. Also Drawing Frames are considered when Drawings are part of input list.
Remaining data concern entities not attached to a drawing.
Constructors(1)
Creates a DispPerDrawing.
Static methods(2)
- get_type_name(): string
Instance methods(3)
Returns as Label, "One File per Drawing".
- CanHaveRemainder(): boolean
Returns True, because of entities attached to no view.
IGESSelect_DispPerSingleView
This type of dispatch defines sets of entities attached to distinct single views. This information appears in the Directory Part. Drawings are taken into account too, because of their frames (proper lists of annotations).
Remaining data concern entities not attached to a single view.
Constructors(1)
Creates a DispPerSingleView.
Static methods(2)
- get_type_name(): string
Instance methods(3)
Returns as Label, "One File per single View or Drawing Frame".
- CanHaveRemainder(): boolean
Returns True, because of entities attached to no view.
IGESSelect_Dumper
Dumper from IGESSelect takes into account, for SessionFile, the classes defined in the package IGESSelect : Selections, Dispatches, Modifiers.
Constructors(1)
Creates a Dumper and puts it into the Library of Dumper.
Static methods(2)
- get_type_name(): string
Instance methods(3)
- WriteOwn(file: IFSelect_SessionFile, item: Standard_Transient): boolean
Write the Own Parameters of Types defined in package
IGESSelectReturns True if has been processed, False else.Parameters (2)fileitem
- ReadOwn(file: IFSelect_SessionFile, type_: TCollection_AsciiString): { returnValue: boolean; item: Standard_Transient; [Symbol.dispose](): void }
Recognizes and Read Own Parameters for Types of package
IGESSelect. Returns True if done and created, False else.Parameters (2)filetype_
ReturnsA result object with fields:
returnValue: the C++ return valueitem: owned by the returned envelope.
Dispose the returned envelope to release owned Handle fields.
IGESSelect_EditDirPart
This class is aimed to display and edit the Directory Part of an IGESEntity.
Constructors(1)
Static methods(2)
- get_type_name(): string
Instance methods(1)
IGESSelect_EditHeader
This class is aimed to display and edit the Header of an IGES Model : Start Section and Global Section.
Constructors(1)
Static methods(2)
- get_type_name(): string
Instance methods(1)
IGESSelect_FileModifier
Static methods(2)
- get_type_name(): string
Instance methods(2)
- Perform(ctx: IFSelect_ContextWrite, writer: IGESData_IGESWriter): void
Perform the action specific to each class of File Modifier <ctx> is the ContextWrite, which brings : the model, the protocol, the file name, plus the object AppliedModifiers (not used here) and the CheckList Remark that the model has to be casted for specific access.
<writer> is the Writer and is specific to each norm, on which to actParameters (2)ctxwriter—Mutated in place; read the updated value from this argument after the call.
IGESSelect_FloatFormat
This class gives control out format for floatting values : ZeroSuppress or no, Main Format, Format in Range (for values around 1.), as IGESWriter allows to manage it. Formats are given under C-printf form.
Constructors(1)
Creates a new FloatFormat, with standard options : ZeroSuppress, Main Format = E, Format between 0.001 and 1000. = f.
Static methods(2)
- get_type_name(): string
Instance methods(8)
- SetDefault(digits?: number): void
Sets FloatFormat to default value (see Create) but if <digits> is given positive, it commands Formats (main and range) to ensure <digits> significant digits to be displayed.
Parameters (1)digits
- SetZeroSuppress(mode: boolean): void
Sets ZeroSuppress mode to a new value.
Parameters (1)mode
- SetFormat(format?: string): void
Sets Main Format to a new value Remark : SetFormat, SetZeroSuppress and SetFormatForRange are independent.
Parameters (1)format
- SetFormatForRange(format?: string, Rmin?: number, Rmax?: number): void
Sets Format for Range to a new value with its range of application. To cancel it, give format as "" (empty string) Remark that if the condition (0. < Rmin < Rmax) is not verified, this secondary format will be ignored. Moreover, this secondary format is intended to be used in a range around 1.
Parameters (3)formatRminRmax
- Format(zerosup: boolean, mainform: TCollection_AsciiString, hasrange: boolean, forminrange: TCollection_AsciiString, rangemin: number, rangemax: number): { zerosup: boolean; hasrange: boolean; rangemin: number; rangemax: number }
Returns all recorded parameters : zerosup : ZeroSuppress status mainform : Main Format (which applies out of the range, or for every real if no range is set) hasrange : True if a FormatInRange is set, False else (following parameters do not apply if it is False) forminrange : Secondary Format (it applies inside the range) rangemin, rangemax : the range in which the secondary format applies.
Parameters (6)zerosupmainform—Mutated in place; read the updated value from this argument after the call.hasrangeforminrange—Mutated in place; read the updated value from this argument after the call.rangeminrangemax
ReturnsA result object with fields:
zerosup: updated value from the call.hasrange: updated value from the call.rangemin: updated value from the call.rangemax: updated value from the call.
- Perform(ctx: IFSelect_ContextWrite, writer: IGESData_IGESWriter): void
Sets the Floatting Formats of IGESWriter to the recorded parameters.
Parameters (2)ctxwriter—Mutated in place; read the updated value from this argument after the call.
Returns specific Label : for instance, "Float Format [ZeroSuppress] %E [, in range R1-R2 %f]".
IGESSelect_IGESName
IGESName is a Signature specific to IGESNorm : it considers the Name of an IGESEntity as being its ShortLabel (some sending systems use name, not to identify entities, but ratjer to classify them).
Constructors(1)
Creates a Signature for IGES Name (reduced to ShortLabel, without SubscriptLabel or Long Name).
Static methods(2)
- get_type_name(): string
Instance methods(2)
- Value(ent: Standard_Transient, model: Interface_InterfaceModel): string
Returns the ShortLabel as being the Name of an IGESEntity If <ent> has no name, it returns empty string "".
Parameters (2)entmodel
IGESSelect_IGESTypeForm
IGESTypeForm is a Signature specific to the IGES Norm : it gives the signature under two possible forms :
- as "mmm nnn", with "mmm" as IGES Type Number, and "nnn" as IGES From Number (even if = 0) [Default]
- as "mmm" alone, which gives only the IGES Type Number
Constructors(1)
- constructor(withform?: boolean): IGESSelect_IGESTypeForm
Creates a Signature for IGES Type & Form Numbers If <withform> is False, for IGES Type Number only.
Parameters (1)withform
Static methods(2)
- get_type_name(): string
Instance methods(3)
- SetForm(withform: boolean): void
Changes the mode for giving the Form Number.
Parameters (1)withform
- Value(ent: Standard_Transient, model: Interface_InterfaceModel): string
Returns the signature for IGES, "mmm nnn" or "mmm" according creation choice (Type & Form or Type only).
Parameters (2)entmodel
IGESSelect_ModelModifier
Static methods(1)
Instance methods(1)
IGESSelect_RebuildDrawings
Rebuilds Drawings which were bypassed to produce new models. If a set of entities, all put into a same IGESModel, were attached to a same Drawing in the starting Model, this Modifier rebuilds the original Drawing, but only with the transferred entities. This includes that all its views are kept too, but empty; and annotations are not kept. Drawing Name is renewed.
If the Input Selection is present, tries to rebuild Drawings only for the selected entities. Else, tries to rebuild Drawings for all the transferred entities.
Constructors(1)
Creates an RebuildDrawings, which uses the system Date.
Static methods(2)
- get_type_name(): string
Instance methods(1)
IGESSelect_RebuildGroups
Rebuilds Groups which were bypassed to produce new models. If a set of entities, all put into a same IGESModel, were part of a same Group in the starting Model, this Modifier rebuilds the original group, but only with the transferred entities. The distinctions (Ordered or not, "WithoutBackP" or not) are renewed, also the name of the group.
If the Input Selection is present, tries to rebuild groups only for the selected entities. Else, tries to rebuild groups for all the transferred entities.
Constructors(1)
Creates an RebuildGroups, which uses the system Date.
Static methods(2)
- get_type_name(): string
Instance methods(1)
IGESSelect_RemoveCurves
Removes Curves UV or 3D (not both !) from Faces, those designated by the Selection. No Selection means all the file.
Constructors(1)
- constructor(UV: boolean): IGESSelect_RemoveCurves
Creates a RemoveCurves from Faces (141/142/143/144) UV True : Removes UV Curves (pcurves) UV False : Removes 3D Curves.
Parameters (1)UV
Static methods(2)
- get_type_name(): string
Instance methods(1)
IGESSelect_SelectBypassGroup
Selects a list built as follows : Groups are entities type 402, forms 1,7,14,15 (Group, Ordered or not, "WithoutBackPointer" or not).
Entities which are not GROUP are taken as such For Groups, their list of Elements is explore Hence, level 0 (D) recursively explores a Group if some of its Elements are Groups. level 1 explores just at first level
Constructors(1)
- constructor(level?: number): IGESSelect_SelectBypassGroup
Creates a SelectBypassGroup, by default all level (level = 1 explores at first level).
Parameters (1)level
Static methods(2)
- get_type_name(): string
Instance methods(2)
Returns a text defining the criterium : "Content of Group".
IGESSelect_SelectBypassSubfigure
Selects a list built as follows : Subfigures correspond to.
- Definition (basic : type 308, or Network : type 320)
- Instance (Singular : type 408, or Network : 420, or patterns : 412,414)
Entities which are not Subfigure are taken as such For Subfigures Instances, their definition is taken, then explored itself For Subfigures Definitions, the list of "Associated Entities" is explored Hence, level 0 (D) recursively explores a Subfigure if some of its Elements are Subfigures. level 1 explores just at first level (i.e. for an instance, returns its definition)
Constructors(1)
- constructor(level?: number): IGESSelect_SelectBypassSubfigure
Creates a SelectBypassSubfigure, by default all level (level = 1 explores at first level).
Parameters (1)level
Static methods(2)
- get_type_name(): string
Instance methods(2)
Returns a text defining the criterium : "Content of Subfigure".
IGESSelect_SelectDrawingFrom
This selection gets the Drawings attached to its input IGES entities. They are read through the Single Views, referenced in Directory Parts of the entities.
Constructors(1)
Creates a SelectDrawingFrom.
Static methods(2)
- get_type_name(): string
Instance methods(2)
Returns the label, with its "Drawings attached".
IGESSelect_SelectFaces
This selection returns the faces contained in an IGES Entity or itself if it is a Face Face means :
- Face (510) of a ManifoldSolidBrep
- TrimmedSurface (144)
- BoundedSurface (143)
- Plane with a Bounding Curve (108, form not 0)
- Also, any Surface which is not in a TrimmedSurface, a BoundedSurface, or a Face (FREE Surface) -> i.e. a Face for which Natural Bounds will be considered
Constructors(1)
Static methods(2)
- get_type_name(): string
Instance methods(2)
Returns a text defining the criterium : "Faces".
IGESSelect_SelectFromDrawing
This selection gets in all the model, the entities which are attached to the drawing(s) given as input. This includes :
- Drawing Frame (Annotations directky referenced by Drawings)
- Entities attached to the single Views referenced by Drawings
Constructors(1)
Creates a SelectFromDrawing.
Static methods(2)
- get_type_name(): string
Instance methods(2)
Returns the label, with is "Entities attached to Drawing".
IGESSelect_SelectFromSingleView
This selection gets in all the model, the entities which are attached to the views given as input. Only Single Views are considered. This information is kept from Directory Part (View Item).
Constructors(1)
Creates a SelectFromSingleView.
Static methods(2)
- get_type_name(): string
Instance methods(2)
Returns the label, with is "Entities attached to single View".
IGESSelect_SelectLevelNumber
This selection looks at Level Number of IGES Entities : it considers items attached, either to a single level with a given value, or to a level list which contains this value.
Level = 0 means entities not attached to any level
Remark : the class CounterOfLevelNumber gives information about present levels in a file.
Constructors(1)
Creates a SelectLevelNumber, with no Level criterium : see SetLevelNumber. Empty, this selection filters nothing.
Static methods(2)
- get_type_name(): string
Instance methods(2)
Returns the Selection criterium : "IGES Entity, Level Number admits <nn>" (if nn > 0) or "IGES Entity attached to no Level" (if nn = 0).
IGESSelect_SelectName
Selects Entities which have a given name. Consider Property Name if present, else Short Label, but not the Subscript Number First version : keeps exact name Later : regular expression.
Constructors(1)
Creates an empty SelectName : every entity is considered good (no filter active).
Static methods(2)
- get_type_name(): string
Instance methods(5)
- Sort(rank: number, ent: Standard_Transient, model: Interface_InterfaceModel): boolean
Returns True if Name of Entity complies with Name Filter.
Parameters (3)rankentmodel
- SetName(name: TCollection_HAsciiString): void
Sets a Name as a criterium : IGES Entities which have this name are kept (without regular expression, there should be at most one). <name> can be regarded as a Text Parameter.
Parameters (1)name
Returns the Name used as Filter.
Returns the Selection criterium : "IGES Entity, Name : <name>".
IGESSelect_SelectPCurves
This Selection returns the pcurves which lie on a face In two modes : global (i.e. a CompositeCurve is not explored) or basic (all the basic curves are listed).
Constructors(1)
- constructor(basic: boolean): IGESSelect_SelectPCurves
Creates a SelectPCurves basic True : lists all the components of pcurves basic False : lists the uppest level definitions (i.e. stops at CompositeCurve).
Parameters (1)basic
Static methods(2)
- get_type_name(): string
Instance methods(2)
Returns a text defining the criterium : "Basic PCurves" or "Global PCurves".
IGESSelect_SelectSingleViewFrom
This selection gets the Single Views attached to its input IGES entities. Single Views themselves or Drawings as passed as such (Drawings, for their Annotations).
Constructors(1)
Creates a SelectSingleViewFrom.
Static methods(2)
- get_type_name(): string
Instance methods(2)
Returns the label, with is "Single Views attached".
IGESSelect_SelectSubordinate
This selections uses Subordinate Status as sort criterium It is an integer number which can be : 0 Independent 1 Physically Dependent 2 Logically Dependent 3 Both (recorded).
- to sort : 4 : 1 or 3 -> at least Physically 5 : 2 or 3 -> at least Logically 6 : 1 or 2 or 3 -> any kind of dependence (corresponds to 0 reversed)
Constructors(1)
- constructor(status: number): IGESSelect_SelectSubordinate
Creates a SelectSubordinate with a status to be sorted.
Parameters (1)status
Static methods(2)
- get_type_name(): string
Instance methods(4)
- Status(): number
Returns the status used for sorting.
- Sort(rank: number, ent: Standard_Transient, model: Interface_InterfaceModel): boolean
Returns True if <ent> is an IGES Entity with Subordinate Status matching the criterium.
Parameters (3)rankentmodel
Returns the Selection criterium : "IGES Entity, Independent" etc...
IGESSelect_SelectVisibleStatus
This selection looks at Blank Status of IGES Entities Direct selection keeps Visible Entities (Blank = 0), Reverse selection keeps Blanked Entities (Blank = 1).
Constructors(1)
Creates a SelectVisibleStatus.
Static methods(2)
- get_type_name(): string
Instance methods(3)
- Sort(rank: number, ent: Standard_Transient, model: Interface_InterfaceModel): boolean
Returns True if <ent> is an IGES Entity with Blank Status = 0.
Parameters (3)rankentmodel
Returns the Selection criterium : "IGES Entity, Status Visible".
IGESSelect_SetGlobalParameter
Sets a Global (Header) Parameter to a new value, directly given Controls the form of the parameter (Integer, Real, String with such or such form), but not the consistence of the new value regarding the rest of the file.
The new value is given under the form of a HAsciiString, even for Integer or Real values. For String values, Hollerith forms are accepted but not mandatory Warning : a Null (not set) value is not accepted. For an empty string, give a Text Parameter which is empty
Constructors(1)
- constructor(numpar: number): IGESSelect_SetGlobalParameter
Creates an SetGlobalParameter, to be applied on Global Parameter <numpar>.
Parameters (1)numpar
Static methods(2)
- get_type_name(): string
Instance methods(4)
- SetValue(text: TCollection_HAsciiString): void
Sets a Text Parameter for the new value.
Parameters (1)text
Returns the value to set to the global parameter (Text Param).
Returns a text which is "Sets Global Parameter <numpar> to <new value>".
IGESSelect_SetLabel
Sets/Clears Short Label of Entities, those designated by the Selection. No Selection means all the file.
May enforce, else it sets only if no label is yet set Mode : 0 to clear (always enforced) 1 to set label to DE number (changes it if already set)
Constructors(1)
- constructor(mode: number, enforce: boolean): IGESSelect_SetLabel
Creates a SetLabel for IGESEntity Mode : see Purpose of the class.
Parameters (2)modeenforce
Static methods(2)
- get_type_name(): string
Instance methods(1)
IGESSelect_SetVersion5
Sets IGES Version (coded in global parameter 23) to be at least IGES 5.1 . If it is older, it is set to IGES 5.1, and LastChangeDate (new Global n0 25) is added (current time) Else, it does nothing (i.e. changes neither IGES Version nor LastChangeDate).
Constructors(1)
Creates an SetVersion5, which uses the system Date for Last Change Date.
Static methods(2)
- get_type_name(): string
Instance methods(1)
IGESSelect_SignColor
Gives Color attached to an entity Several forms are possible, according to <mode> 1 : number : "Dnn" for entity, "Snn" for standard, "(none)" for 0 2 : name : Of standard color, or of the color entity, or "(none)" (if the color entity has no name, its label is taken) 3 : RGB values, form R:nn,G:nn,B:nn 4 : RED value : an integer 5 : GREEN value : an integer 6 : BLUE value : an integer Other computable values can be added if needed : CMY values, Percentages for Hue, Lightness, Saturation.
Constructors(1)
- constructor(mode: number): IGESSelect_SignColor
Creates a SignColor mode : see above for the meaning modes 4,5,6 give a numeric integer value Name is initialised according to the mode.
Parameters (1)mode
Static methods(2)
- get_type_name(): string
Instance methods(2)
- Value(ent: Standard_Transient, model: Interface_InterfaceModel): string
Returns the value (see above).
Parameters (2)entmodel
IGESSelect_SignLevelNumber
Gives D.E. Level Number under two possible forms :
- for counter : "LEVEL nnnnnnn", " NO LEVEL", " LEVEL LIST"
- for selection : "/nnn/", "/0/", "/1/2/nnn/"
For matching, giving /nn/ gets any entity attached to level nn whatever simple or in a level list
Constructors(1)
- constructor(countmode: boolean): IGESSelect_SignLevelNumber
Creates a SignLevelNumber <countmode> True : values are naturally displayed <countmode> False: values are separated by slashes in order to allow selection by signature by Draw or C++.
Parameters (1)countmode
Static methods(2)
- get_type_name(): string
Instance methods(2)
- Value(ent: Standard_Transient, model: Interface_InterfaceModel): string
Returns the value (see above).
Parameters (2)entmodel
IGESSelect_SignStatus
Gives D.E. Status under the form i,j,k,l (4 figures) i for BlankStatus j for SubordinateStatus k for UseFlag l for Hierarchy.
For matching, allowed shortcuts B(Blanked) or V(Visible) are allowed instead of i I(Independant=0), P(Physically Dep.=1), L(Logically Dep.=2) or D(Dependant=3) are allowed instead of j These letters must be given in their good position For non-exact matching : a letter (see above), no comma : only this status is checked nothing or a star between commas : this status is OK
Constructors(1)
Static methods(2)
- get_type_name(): string
Instance methods(3)
- Value(ent: Standard_Transient, model: Interface_InterfaceModel): string
Returns the value (see above).
Parameters (2)entmodel
- Matches(ent: Standard_Transient, model: Interface_InterfaceModel, text: TCollection_AsciiString, exact: boolean): boolean
Performs the match rule (see above).
Parameters (4)entmodeltextexact
IGESSelect_SplineToBSpline
This type of Transformer allows to convert Spline Curves (IGES type 112) and Surfaces (IGES Type 126) to BSpline Curves (IGES type 114) and Surfac (IGES Type 128). All other entities are rebuilt as identical but on the basis of this conversion.
It also gives an option to, either convert as such (i.e. each starting part of the spline becomes a segment of the bspline, with continuity C0 between segments), or try to increase continuity as far as possible to C1 or to C2.
It does nothing if the starting model contains no Spline Curve (IGES Type 112) or Surface (IGES Type 126). Else, converting and rebuilding implies copying of entities.
Constructors(1)
- constructor(tryC2: boolean): IGESSelect_SplineToBSpline
Creates a Transformer SplineToBSpline. If <tryC2> is True, it will in addition try to upgrade continuity up to C2.
Parameters (1)tryC2
Static methods(2)
- get_type_name(): string
Instance methods(4)
- OptionTryC2(): boolean
Returns the option TryC2 given at creation time.
- Updated(entfrom: Standard_Transient): { returnValue: boolean; entto: Standard_Transient; [Symbol.dispose](): void }
Returns the transformed entities. If original data contained no Spline Curve or Surface, the result is identity : <entto> = <entfrom> Else, the copied counterpart is returned : for a Spline Curve or Surface, it is a converted BSpline Curve or Surface. Else, it is the result of general service Copy (rebuilt as necessary by BSPlines replacing Splines).
Parameters (1)entfrom
ReturnsA result object with fields:
returnValue: the C++ return valueentto: owned by the returned envelope.
Dispose the returned envelope to release owned Handle fields.
Returns a text which defines the way a Transformer works : "Conversion Spline to BSpline" and as opted, " trying to upgrade continuity".
IGESSelect_UpdateCreationDate
Allows to Change the Creation Date indication in the Header (Global Section) of IGES File. It is taken from the operating system (time of application of the Modifier). The Selection of the Modifier is not used : it simply acts as a criterium to select IGES Files to touch up.
Constructors(1)
Creates an UpdateCreationDate, which uses the system Date.
Static methods(2)
- get_type_name(): string
Instance methods(1)
IGESSelect_UpdateFileName
Sets the File Name in Header to be the actual name of the file If new file name is unknown, the former one is kept Remark : this works well only when it is Applied and send time If it is run immediately, new file name is unknown and nothing is done The Selection of the Modifier is not used : it simply acts as a criterium to select IGES Files to touch up.
Constructors(1)
Creates an UpdateFileName, which uses the system Date.
Static methods(2)
- get_type_name(): string
Instance methods(1)
IGESSelect_UpdateLastChange
Allows to Change the Last Change Date indication in the Header (Global Section) of IGES File. It is taken from the operating system (time of application of the Modifier). The Selection of the Modifier is not used : it simply acts as a criterium to select IGES Files to touch up. Remark : IGES Models noted as version before IGES 5.1 are in addition changed to 5.1.
Constructors(1)
Creates an UpdateLastChange, which uses the system Date.
Static methods(2)
- get_type_name(): string
Instance methods(1)
IGESSelect_ViewSorter
Sorts IGES Entities on the views and drawings. In a first step, it splits a set of entities according the different views they are attached to. Then, packets according single views (+ drawing frames), or according drawings (which refer to the views) can be determined.
It is a TShared, hence it can be a workomg field of a non- mutable object (a Dispatch for instance)
Constructors(1)
Creates a ViewSorter, empty. SetModel remains to be called.
Static methods(2)
- get_type_name(): string
Instance methods(11)
- Clear(): void
Clears recorded data.
- Add(ent: Standard_Transient): boolean
Adds an item according its type : AddEntity,AddList,AddModel.
Parameters (1)ent
- AddEntity(igesent: IGESData_IGESEntity): boolean
Adds an IGES entity. Records the view it is attached to. Records directly <ent> if it is a ViewKindEntity or a Drawing Returns True if added, False if already in the map.
Parameters (1)igesent
- AddList(list: NCollection_HSequence_handle_Standard_Transient): void
Adds a list of entities by adding each of the items.
Parameters (1)list
- AddModel(model: Interface_InterfaceModel): void
Adds all the entities contained in a Model.
Parameters (1)model
- NbEntities(): number
Returns the count of already recorded.
- SortSingleViews(alsoframes: boolean): void
Prepares the result to keep only sets attached to Single Views If <alsoframes> is given True, it keeps also the Drawings as specific sets, in order to get their frames. Entities attached to no single view are put in Remaining List.
Result can then be read by the methods NbSets,SetItem,SetList, RemainingList(final = True)Parameters (1)alsoframes
- NbSets(final: boolean): number
Returns the count of sets recorded, one per distinct item. The Remaining List is not counted. If <final> is False, the sets are attached to distinct views determined by the method Add. If <final> is True, they are the sets determined by the last call to, either SortSingleViews, or SortDrawings.
Warning : Drawings directly recorded are also counted as sets, because of their Frame (which is made of Annotations)Parameters (1)final
- SetItem(num: number, final: boolean): IGESData_IGESEntity
Returns the Item which is attached to a set of entities For <final> and definition of sets, see method NbSets. This item can be a kind of View or a Drawing.
Parameters (2)numfinal
- Sets(final: boolean): IFSelect_PacketList
Returns the complete content of the determined Sets, which include Duplicated and Remaining (duplication 0) lists For <final> and definition of sets, see method NbSets.
Parameters (1)final
IGESSelect_WorkLibrary
Performs Read and Write an IGES File with an IGES Model.
Constructors(1)
- constructor(modefnes?: boolean): IGESSelect_WorkLibrary
Creates a IGES WorkLibrary If <modefnes> is given as True, it will work for FNES.
Parameters (1)modefnes
Static methods(3)
- get_type_name(): string
Instance methods(3)
- ReadFile(name: string, protocol: Interface_Protocol): { returnValue: number; model: Interface_InterfaceModel; [Symbol.dispose](): void }
Reads a IGES File and returns a IGES Model (into <mod>), or lets <mod> "Null" in case of Error Returns 0 if OK, 1 if Read Error, -1 if File not opened.
Parameters (2)nameprotocol
ReturnsA result object with fields:
returnValue: the C++ return valuemodel: owned by the returned envelope.
Dispose the returned envelope to release owned Handle fields.
- WriteFile(ctx: IFSelect_ContextWrite): boolean
Writes a File from a IGES Model (brought by <ctx>) Returns False (and writes no file) if <ctx> is not for IGES.
Parameters (1)ctx