Class TopologyAPI

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

This class implements APIs for Topology.

public static class TopologyAPI

Inheritance

object ← TopologyAPI

Extension Methods

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

Methods

ChangeEdgeColor(IDocument, IEnumerable<Obj>, Color?, SetColorType)

Change the topology edge.

[NotNull(new string[] { "document", "edges" })]
public static void ChangeEdgeColor(this IDocument document, IEnumerable<Obj> edges, Color? color = null, SetColorType setColor = SetColorType.Set)

Parameters

document IDocument

The document to change the topology edge.

edges IEnumerable<Obj>

The edges of the topology.

color Color?

The color of the topology.

setColor SetColorType

The falg of color setting of the topology.

Exceptions

ArgumentNullException

Will be thrown if 'document', 'edges' argument is null.

ArgumentException

Will be thrown if the type of 'document' is not and .

ArgumentException

Will be thrown if the type of 'edges' is not .

ChangeFaceColor(IDocument, IEnumerable<Obj>, Color?, SetColorType)

Change the topology face.

[NotNull(new string[] { "document", "faces" })]
public static void ChangeFaceColor(this IDocument document, IEnumerable<Obj> faces, Color? color = null, SetColorType setColor = SetColorType.Set)

Parameters

document IDocument

The document to change the topology face.

faces IEnumerable<Obj>

The faces of the topology.

color Color?

The color of the topology.

setColor SetColorType

The falg of color setting of the topology.

Exceptions

ArgumentNullException

Will be thrown if 'document', 'faces' argument is null.

ArgumentException

Will be thrown if the type of 'document' is not and .

ArgumentException

Will be thrown if the type of 'faces' is not .