OBJExportOptions

Public Class

The export options used by exporting to OBJ file format.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.BIMExportOptions
Autodesk.Revit.DB.OBJExportOptions

Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public class OBJExportOptions : BIMExportOptions

The OBJExportOptions type exposes the following members.

Constructors

Name

Description

Public Method
OBJExportOptions.

Constructs a new instance of OBJExportOptions with default values of all properties.

Public Method
OBJExportOptions(ExportResolution)

Constructs a new instance of OBJExportOptions with all predefined tessellation settings, depending on export resolution type. Note: in case of Custom resolution type, tessellation settings won’t be predefined and will have default values.

Properties

Name

Description

Public Property
GridAspectRatio

The maximum aspect ratio allowed in the grid placed across the face. The minimum allowed value is 1.0. The maximum allowed value is 10.0. By default this property is ignored.

Public Property
IsValidObject

Specifies whether the .NET object represents a valid Revit entity.
(Inherited from BIMExportOptions)

Public Property
MaxEdgeLength

The maximum length allowed for any chord on an edge or between any two adjacent grid lines. This is a percentage value. By exporting, the real value of maximum edge length is calculated as a percent from the length of the diameter of the body bounding box. The minimum allowed value is 0.1%. The maximum allowed value is 10.0%. By default this property is ignored.

Public Property
NormalTolerance

The maximum change in the surface normal between adjacent nodes in the mesh. This property is defined in degrees. The minimum allowed value is 1.0 degrees. The maximum allowed value is 45.0 degrees. Default value is 15.0 degrees.

Public Property
SurfaceTolerance

The maximum distance between mesh triangles and model geometry. This is a percentage value. By exporting, the real value of surface tolerance is calculated as a percent from the length of the diameter of the body bounding box. The minimum allowed value is 0.001%. The maximum allowed value is 1.0%. Default value is 0.1%.

Public Property

TargetUnit

The unit type of geometry in the resultant OBJ file. Default value is ExportUnit::Default.

Public Property

ViewId

The element id of the 3D view to export. InvalidElementId by default.
(Inherited from BIMExportOptions)

Methods

Name

Description

Public Method

Dispose

(Inherited from BIMExportOptions)

Public Method

Equals

Determines whether the specified object is equal to the current object.
(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)

Public Method

IsGridAspectRatioSet

Checks whether the GridAspectRatio tessellation parameter is explicitly set.

Public Method

IsMaxEdgeLengthSet

Checks whether the MaxEdgeLength tessellation parameter is explicitly set.

Public Method

IsNormalToleranceSet

Checks whether the NormalTolerance tessellation parameter is explicitly set.

Public Method

IsSurfaceToleranceSet

Checks whether the SurfaceTolerance tessellation parameter is explicitly set.

Public Method
Static Member

IsValidForGridAspectRatio

Checks whether the value is allowed (is in the allowed range) for GridAspectRatio tessellation parameter.

Public Method
Static Member

IsValidForMaxEdgeLength

Checks whether the value is allowed (is in the allowed range) for MaxEdgeLength tessellation parameter.

Public Method
Static Member

IsValidForNormalTolerance

Checks whether the value is allowed (is in the allowed range) for NormalTolerance tessellation parameter.

Public Method
Static Member

IsValidForSurfaceTolerance

Checks whether the value is allowed (is in the allowed range) for SurfaceTolerance tessellation parameter.

Public Method

SetTessellationSettings

Sets all the tessellation parameters to its predefined values for the given resolution type.

Public Method

ToString

Returns a string that represents the current object.
(Inherited from Object)