Class MeshDocumentAPI

Namespace: VM.API.Pre.FE
Assembly: VM.API.Pre.FE.dll

This class implements APIs for class.

public static class MeshDocumentAPI

Inheritance

object ← MeshDocumentAPI

Extension Methods

LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType), LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType), LinkPropertyItemCache.GetLinkedObjects<T>(object, LinkPropertyType)

Methods

CreateNewMeshDocument(string, string, Unit, double)

Create .

[NotNullOrEmpty(new string[] { "newMeshFilePath" })]
public static MeshDocument CreateNewMeshDocument(string newMeshFilePath, string documentName = "Mesh", Unit unit = null, double iconSize = 1)

Parameters

newMeshFilePath string

The file path of new mesh.

documentName string

The name of document.

unit Unit

The unit information.

iconSize double

The size of icon.

Returns

MeshDocument

The new SubSystemDocument object that is created by this API.

Exceptions

ArgumentNullException

Will be thrown if 'newMeshFilePath' argument is empty.

ImportMesh(MeshDocument, string, string, Color?, bool, bool)

Import external mesh file such as bdf/dat into the

[NotNull(new string[] { "doc" })]
[ExistFile(new string[] { "feDataFilePath" })]
public static Obj ImportMesh(this MeshDocument doc, string feDataFilePath, string modalDataFileName = "", Color? meshColor = null, bool degenerateElement = false, bool modalOnly = false)

Parameters

doc MeshDocument

The to import external mesh file.

feDataFilePath string

The path to the external mesh file.

modalDataFileName string

The path to the modal data file.

meshColor Color?

The of the new mesh,

degenerateElement bool

The flag for degenerate element.

modalOnly bool

The flag for modal only.

Returns

Obj

The new object.

Exceptions

ArgumentNullException

Will be thrown when doc or feDataFilePath is null,

FileNotFoundException

Will be thrown if feDataFilePath file is not exist.