Namespace AntFarm.API

Classes

AntFarmAPI

The main API class. Contains all methods and events to access AntFarm internal data storage and manipulation system.

APIAttribute

Attributes define the data in a DataSet. Attributes are of single types.

The APIAttribute class does not provide public constructors. Please refer to:

in class AntFarmAPI.

// Create Attribute of type String
APIAttribute attribute = AntFarmAPI.NewAttribute(yourClientId, "yourAttributeName", APIAttributeType.String);

APICategory

APICategory is an AntFarm specific AntFarm.Kernel.Types.Attributes.AFAttributeType. Categories hold APIElement(s). An APIElement can hold additional information in APIProperty(s).

The APICategory class does not provide public constructors. Please refer to:

  • ,
in class AntFarmAPI.

// elements as List<APIElement> (see APIElement)
APICategory category = AntFarmAPI.NewCategory(yourClientId, "yourCategoryName", elements);

APIDataSet

Use this class to interact with the AntFarm Database.

The APIDataSet class does not provide public constructors. Please refer to:

in class AntFarmAPI.

// settings as APIDataSetSettings (see APIDataSetSettings)
APIDataSet dataSet = AntFarmAPI.NewDataSet(yourClientId, "yourDataSetName", settings);

APIDataSetSettings

Use this class to interact with the DataSet Settings.

The APIDataSetSettings class does not provide public constructors. Please refer to:

in class AntFarmAPI.

// settings as APIDataSetSettings (see APIDataSetSettings)
APIDataSet dataSet = AntFarmAPI.NewDataSet(yourClientId, "yourDataSetName", settings);

APIElement

Use this class to interact with the AntFarm Category Elements.

The APIElement class does not provide public constructors. Please refer to:

in class AntFarmAPI.

// properties as List<APIProperty> (see APIProperty) 
APIElement element = AntFarmAPI.NewElement(yourClientId, "yourElementName", properties);

APIException

API exception class. All internal thrown exceptions will be cast to APIExceptions.

APIProperty

Use this class to interact with the AntFarm Category Element Property.

The APIProperty class does not provide public constructors. Please refer to:

in class AntFarmAPI.

// type as APIPropertyType, value as System.Object 
APIProperty property = AntFarmAPI.NewProperty(yourClientId, "yourPropertyName", type, value);

APIPropertyType

APIRecord

Use this class to interact with the AntFarm DataSet Records.

The APIRecord class does not provide public constructors. Please refer to:

in class AntFarmAPI.

// values as Dictionary<APIAttribute, object> - needs to match the Attributes in this DataSet
APIRecord record = AntFarmAPI.NewRecord(rhinoObjectId, values, rhinoObject);

APISchema

Use this class to interact with the AntFarm APISchema.

The APISchema class does not provide public constructors. Please refer to:

in class AntFarmAPI.

// settings as APIDataSetSettings (see APIDataSetSettings)
APISchema schema = AntFarmAPI.NewSchema(yourClientId, "yourDataSetName", yourDataSetId, yourDataSetColour, createLayer, layerName, layerColour);

Used for writing data and Rhino Objects into the AntFarm Database when you know nothing about the current state of the database Should Only be used for Plug-ins that read data from file formats, generate rhino geometry and then want to link the Geometry to the data from the read in file.

Structs

APIColour

Use this class to interact with the AntFarm DataSetSetting Colours.

The APIColour class does not provide public constructors. Please refer to:

in class AntFarmAPI.

Enums

APIExceptionCode

Predefined exception codes