ReadSTEP Class

Utility class for loading STEP files asynchronously.
Public Class ReadSTEP 
Inherits ReadFileAsyncWithBlocksAndLayers
This language is not supported or no code example is available.
public class ReadSTEP : ReadFileAsyncWithBlocksAndLayers
This language is not supported or no code example is available.
Name Description
Public constructor ReadSTEP(Stream) File stream constructor.
Public constructor ReadSTEP(string) File name constructor.
Top
Name Description
Public property Blocks Gets or sets the blocks resulting from file reading. (inherited from ReadFileAsyncWithBlocks).
Public property EncapsulateSiblings

When true, entities at the same level of BlockReferences are encapsulated inside a new block.

Many CAD systems have difficulties to handle individual entities at the same level of BlockReferences. Using this flag, all individual entities at the same level of BlockReferences are replaced by a BlockReference with a name at random.

Public property Entities Gets the entities resulting from file reading. (inherited from ReadFileAsync).
Public property ExecutionTime Gets the (last) work execution time in milliseconds. (inherited from WorkUnit).
Public property FileName Gets the file name. (inherited from ReadFileAsync).
Public property Log Gets the list of errors and warnings generated during execution. (inherited from WorkUnit).
Public property ParsingBlocksText Gets or sets the "Parsing blocks..." text string. (inherited from ReadFileAsyncWithBlocks).
Public property ParsingEntitiesText Gets or sets the "Parsing entities..." text string. (inherited from ReadFileAsync).
Public property ParsingText Gets or sets the "Parsing..." text string. (inherited from ReadFileAsync).
Public property Path Gets input file path. (inherited from ReadFileAsync).
Public property ReadingText Gets or sets the "Reading..." text string. (inherited from ReadFileAsync).
Public property Result Gets the result of reading operation (true if the operation succeeded). (inherited from ReadFileAsync).
Public property Simplify Controls if generic surfaces are converted to PlanarSurface, TabulatedSurface or RevolvedSurface to improve import speed.
Public property Status Gets the WorkUnit status. (inherited from WorkUnit).
Public property Stream Gets current stream. (inherited from ReadFileAsync).
Public property SupportedLinearUnitsType Gets the supported linear units
Public property Units Gets or sets imported geometry linear units. (inherited from ReadFileAsyncWithBlocks).
Top
Methods
 
Name Description
Public method AddToScene(Environment, RegenOptions) Adds to the Environment control the entities loaded from the file, along with the other master collections. Items contained previously in the Environment are merged, except the root block that is replaced with the one loaded from the file, if it exists. (inherited from ReadFileAsyncWithBlocks).
Public method AddToScene(Environment, bool, RegenOptions) Adds to the Environment control the entities loaded from the file, along with the other master collections. Items contained previously in the Environment are merged. (inherited from ReadFileAsyncWithBlocks).
Internal protected (Protected Friend) method Cancelled(BackgroundWorker, DoWorkEventArgs) Checks if the user has requested cancellation of the background operation. (inherited from WorkUnit).
Internal protected (Protected Friend) method CloseStream() Closes the stream. Must be called by all derived classes. (inherited from ReadFileAsync).
Internal protected (Protected Friend) method DoWork(BackgroundWorker, DoWorkEventArgs) Does the actual work allowing progress bar update and cancellation.
Public method Equals(Object) Determines whether the specified object is equal to the current object. (inherited from Object).
Public method FillAllCollectionsData(Environment) Automatically merges all master collections with existing ones. (inherited from ReadFileAsync).
Public method FillBlocks(Environment, bool, RegenOptions, bool) Automatically merges block definitions with existing ones. (inherited from ReadFileAsyncWithBlocks).
Public method FillLayers(Environment) Automatically merges layers with existing ones. (inherited from ReadFileAsyncWithBlocksAndLayers).
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (inherited from Object).
Public method GetHashCode Serves as the default hash function. (inherited from Object).
Public method GetType Gets the Type of the current instance. (inherited from Object).
Protected method MemberwiseClone Creates a shallow copy of the current Object. (inherited from Object).
Internal protected (Protected Friend) method ResetProgressParallel(int) Resets the progress bar for a parallel loop. (inherited from WorkUnit).
Public method RotateEverythingAroundX(double) Rotates geometry around world X axis. If the file was created in a system that orients with Y Axis Up, the models would by default be brought into Eyeshot (a Z axis up system) with a flipped coordinate system. This method is designed to fix the problem. (inherited from ReadFileAsyncWithBlocks).
Internal protected (Protected Friend) method StartContinuousAnimation(string, BackgroundWorker, params string[]) Start the animation for the continuous progress bar. (inherited from WorkUnit).
Internal protected (Protected Friend) method StopContinuousAnimation(BackgroundWorker) Stop the animation for the continuous progress bar. (inherited from WorkUnit).
Public method ToString Returns a string that represents the current object. (inherited from Object).
Internal protected (Protected Friend) method UpdateProgress(double, double, string, BackgroundWorker, bool, params string[]) Updates the progress bar value. (inherited from WorkUnit).
Internal protected (Protected Friend) method UpdateProgress(int, int, string, BackgroundWorker, bool, params string[]) Updates the progress bar value. (inherited from WorkUnit).
Internal protected (Protected Friend) method UpdateProgressAndCheckCancelled(int, int, string, BackgroundWorker, DoWorkEventArgs, bool, params string[]) Updates the progress bar value and checks if the worker thread has been canceled. (inherited from WorkUnit).
Internal protected (Protected Friend) method UpdateProgressAndCheckCancelledParallel(int, string, BackgroundWorker, DoWorkEventArgs, params string[]) Updates the progress bar value and checks if the worker thread has been canceled, for a parallel loop. (inherited from WorkUnit).
Internal protected (Protected Friend) method UpdateProgressParallel(double, string, BackgroundWorker, params string[]) Updates the progress bar value for a parallel loop. (inherited from WorkUnit).
Internal protected (Protected Friend) method UpdateProgressTo100(string, BackgroundWorker, params string[]) Set the progress bar to 100% and forces screen update. (inherited from WorkUnit).
Internal protected (Protected Friend) method WorkCancelled(Environment) Called when the work is cancelled. (inherited from ReadFileAsync).
Internal protected (Protected Friend) method WorkCompleted(Environment) Called when the work has completed. In the case you are modeling something, the environment parameter allows you to easily add the model to the entities collection. (inherited from WorkUnit).
Internal protected (Protected Friend) method WorkFailed(Environment) Called when the work has failed. (inherited from WorkUnit).
Top
Events
 
Name Description
Public event ProgressChanged Occurs when the DoWork() is called synchronously and the progress has changed. (inherited from WorkUnit).
Top
Fields
 
Name Description
Public field Layers Gets or sets the list of layers resulting from file reading. (inherited from ReadFileAsyncWithBlocksAndLayers).
Internal protected (Protected Friend) field log (inherited from WorkUnit).
Protected field readFileCloseStream (inherited from ReadFileAsync).
Top

.NET Framework

Supported in: 4.8

In this article

Definition