WriteOBJ Class

Helper class to export geometry in OBJ file format.
Public Class WriteOBJ 
Inherits WriteFileAsyncWithUnits
This language is not supported or no code example is available.
public class WriteOBJ : WriteFileAsyncWithUnits
This language is not supported or no code example is available.
Name Description
Public constructor WriteOBJ(Environment, Stream, bool) Obsolete. Standard constructor with stream.
Public constructor WriteOBJ(Environment, Stream, double, bool) Obsolete. To stream with deviation constructor. The exported model will be regenerated with specified deviation.
Public constructor WriteOBJ(Environment, string, bool) Obsolete. Standard constructor.
Public constructor WriteOBJ(Environment, string, double, bool) Obsolete. Deviation constructor. The exported model will be regenerated with specified deviation.
Public constructor WriteOBJ(IList<Entity>, IEnumerable<Layer>, IDictionary<StringBlock>, IDictionary<StringMaterial>, Stream, double, linearUnitsType, bool) Obsolete. To stream with deviation constructor. The exported model will be regenerated with specified deviation.
Public constructor WriteOBJ(IList<Entity>, IEnumerable<Layer>, IDictionary<StringBlock>, IDictionary<StringMaterial>, Stream, linearUnitsType, bool) Obsolete. Standard constructor with stream.
Public constructor WriteOBJ(IList<Entity>, IEnumerable<Layer>, IDictionary<StringBlock>, IDictionary<StringMaterial>, string, double, linearUnitsType, bool) Obsolete. Deviation constructor. The exported model will be regenerated with specified deviation.
Public constructor WriteOBJ(IList<Entity>, IEnumerable<Layer>, IDictionary<StringBlock>, IDictionary<StringMaterial>, string, linearUnitsType, bool) Obsolete. Standard constructor.
Public constructor WriteOBJ(WriteParamsWithMaterials, Stream) Standard constructor with document and stream.
Public constructor WriteOBJ(WriteParamsWithMaterials, Stream, double) To stream with document and deviation constructor. The exported model will be regenerated with specified deviation.
Public constructor WriteOBJ(WriteParamsWithMaterials, string) Standard constructor with document and filename.
Public constructor WriteOBJ(WriteParamsWithMaterials, string, double) Document and deviation constructor. The exported model will be regenerated with specified deviation.
Top
Name Description
Public property Angle Gets or sets the maximum angular deflection in radians, ignored when zero. (inherited from WriteFileAsync).
Public property ComposingBlocksText Gets or sets the "Composing blocks..." text string. (inherited from WriteFileAsync).
Public property ComposingEntitiesText Gets or sets the "Composing entities..." text string. (inherited from WriteFileAsync).
Public property ComposingText Gets or sets the "Composing..." text string. (inherited from WriteFileAsync).
Public property Deviation Gets or sets the maximum deviation, zero for current tessellation. (inherited from WriteFileAsync).
Public property ExecutionTime Gets the (last) work execution time in milliseconds. (inherited from WorkUnit).
Public property FileName The name of the file that will be created. (inherited from WriteFileAsync).
Public property Log Gets the list of errors and warnings generated during file export. (inherited from WriteFileAsync).
Public property Stream The stream for writing. (inherited from WriteFileAsync).
Public property Static SupportedLinearUnitsType Gets the supported linear units
Public property WritingText Gets or sets the "Writing..." text string. (inherited from WriteFileAsync).
Top
Methods
 
Name Description
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() (inherited from WriteFileAsync).
Protected method ComputeBoundingBox(out Point3D, out Point3D) Compute scene extents. (inherited from WriteFileAsync).
Internal protected (Protected Friend) method DoWork(BackgroundWorker, DoWorkEventArgs) Does the actual work allowing progress bar update and cancellation.
Public method DoWork() Executes the work synchronously. (inherited from WorkUnit).
Public method Equals(Object) Determines whether the specified object is equal to the current object. (inherited from Object).
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 InitLayers(LayerKeyedCollection) Initializes the layers collection with only the exportable ones. (inherited from WriteFileAsync).
Protected method MemberwiseClone Creates a shallow copy of the current Object. (inherited from Object).
Internal protected (Protected Friend) method ResetProgressParallel() Resets the progress bar for a parallel loop. (inherited from WorkUnit).
Internal protected (Protected Friend) method SetWriter(IDisposable) (inherited from WriteFileAsync).
Internal protected (Protected Friend) method StartContinuousAnimation(string, BackgroundWorker) 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).
Protected method SynchronizeAttributeReference(BlockKeyedCollection, IList<Entity>) Helper method to synchronize all the attribute reference before writing the file.
Protected method SynchronizeAttributeReference(Environment) Helper method to synchronize all the attribute reference before writing the file.
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) Updates the progress bar value.
Internal protected (Protected Friend) method UpdateProgress(int, int, string, BackgroundWorker, bool) Updates the progress bar value.
Internal protected (Protected Friend) method UpdateProgressAndCheckCancelled(int, int, string, BackgroundWorker, DoWorkEventArgs, bool) 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) 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) Updates the progress bar value for a parallel loop. (inherited from WorkUnit).
Internal protected (Protected Friend) method UpdateProgressTo100(string, BackgroundWorker) 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 WriteFileAsync).
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
Protected field author (inherited from WriteFileAsyncWithUnits).
Protected field blocks (inherited from WriteFileAsync).
Protected field entities (inherited from WriteFileAsync).
Internal protected (Protected Friend) field errorLog The string builder for log. (inherited from WriteFileAsync).
Protected field layers (inherited from WriteFileAsync).
Protected field materials
Protected field organization (inherited from WriteFileAsyncWithUnits).
Protected field originatingSystem (inherited from WriteFileAsyncWithUnits).
Protected field selectedOnly When true only the selected entities will be written. (inherited from WriteFileAsync).
Protected field units (inherited from WriteFileAsyncWithUnits).
Protected field writeFileCloseStream True when the constructors with filename is used, otherwise false. (inherited from WriteFileAsync).
Top

.NET Framework

Supported in: 4.5, 4.6, 4.7

In this article

Definition