Class FEFilmAPI

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

This class implements APIs for ball placing.

public static class FEFilmAPI

Inheritance

object ← FEFilmAPI

Extension Methods

LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType), LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType), LinkPropertyItemCache.GetLinkedObjects(object, LinkPropertyType)

Methods

AddPath(Obj, Obj, WindingDirection, ExpressionValueVariable)

Add path.

[NotNullObj(new string[] { "film", "designSubentity" })]
[MatchTypeObj(new object[] { "film", typeof(FEFilm) })]
[GreaterThanZero(new string[] { "radius" })]
public static void AddPath(this Obj film, Obj designSubentity, WindingDirection windingDirection, ExpressionValueVariable radius)

Parameters

film Obj

The fe film to add path.

designSubentity Obj

The design subentity.

windingDirection WindingDirection

The winding direction type.

radius ExpressionValueVariable

The radius.

Exceptions

ArgumentNullException

Will be thrown if 'film', 'designSubentity' are null.

ArgumentException

Will be thrown if item type of 'film' is not .

ArgumentException

Will be thrown if item type of 'designSubentity' is not or .

ArgumentOutOfRangeException

Will be thrown if the 'radius' value is equal to or less than 0.

ChangeName(string, string)

Change name.

[NotNullOrEmpty(new string[] { "oldName", "newName" })]
public static void ChangeName(string oldName, string newName)

Parameters

oldName string

The old name.

newName string

The new name.

Exceptions

ArgumentNullException

Will be thrown if 'oldName', 'newName' are null.

ClearPath(Obj)

Clear path.

[NotNullObj(new string[] { "film" })]
[MatchTypeObj(new object[] { "film", typeof(FEFilm) })]
public static void ClearPath(this Obj film)

Parameters

film Obj

The fe film to clear path.

Exceptions

ArgumentNullException

Will be thrown if 'film' is null.

ArgumentException

Will be thrown if item type of 'film' is not .

CreateFEFilm(SubSystemDocument, IEnumerable, string)

Create fe film .

[NotNull(new string[] { "document", "paths" })]
public static Obj CreateFEFilm(this SubSystemDocument document, IEnumerable<obj> paths, string name = "")

Parameters

document SubSystemDocument

The document to create the fe film.

paths IEnumerable

The paths to create the fe film.

name string

The name of the . If empty, default name starts with 'FEFilm_' will be generated and used.

Returns

Obj

The new object that is created by this API.

Exceptions

ArgumentNullException

Will be thrown if 'document', 'paths' are null.