Provides access to instance (block) definitions in the 3dm file.

Properties

ComponentType

#Since v6.0
public override ModelComponentType ComponentType { get; }

Count

Returns the count of all items, including deleted ones.
public virtual int Count { get; }
inherited fromCommonComponentTable<T>

Methods

Add

#Since v6.5
Adds an instance definition to the instance definition table.
public int Add(
name,
The definition name.
description,
The definition description.
basePoint,
A base point.
geometry,
An element.
attributes
An attribute.
)
>=0 index of instance definition in the instance definition table. -1 on failure.

Add

#Since v6.5
Adds an instance definition to the instance definition table.
public int Add(
name,
The definition name.
description,
The definition description.
basePoint,
A base point.
geometry,
An array, a list or any enumerable set of geometry.
attributes
An array, a list or any enumerable set of attributes.
)
>=0 index of instance definition in the instance definition table. -1 on failure.

Add

#Since v6.5
Adds an instance definition to the instance definition table.
public int Add(
name,
The definition name.
description,
The definition description.
basePoint,
A base point.
geometry
An array, a list or any enumerable set of geometry.
)
>=0 index of instance definition in the instance definition table. -1 on failure.

Add

#Since v7.0
Adds an instance definition to the instance definition table.
public int Add(
name,
The definition name.
description,
The definition description.
url,
A URL or hyperlink.
urlTag,
A description of the URL or hyperlink.
basePoint,
A base point.
geometry,
An array, a list or any enumerable set of geometry.
attributes
An array, a list or any enumerable set of attributes.
)
>=0 index of instance definition in the instance definition table. -1 on failure.

Add

Adds an item.
public virtual void Add(
T
item
The item to add.
)
inherited fromFile3dmCommonComponentTable<T>

AddLinked

#Since v6.13
Adds a linked instance definition to the instance definition table.
public int AddLinked(
filename,
Full path of the file to link.
name,
The definition name.
description
The definition description.
)

Clear

Marks all items as deleted.
public void Clear()
inherited fromCommonComponentTable<T>

Delete

Flags a component as deleted.
public override bool Delete(
T
item
The item to flag.
)
inherited fromFile3dmCommonComponentTable<T>
True on success.

Delete

Flags a component as deleted.
public virtual void Delete(
index
The index of the item to flag.
)
inherited fromFile3dmCommonComponentTable<T>
True on success.

Dump

Prepares a text dump of object table.
public string Dump()
inherited fromFile3dmCommonComponentTable<T>
A string containing the dump.

FindId

Uses the guid to find a model component. Deleted objects cannot be found by id. The guid is the value that is stored in the .Id property. In a single document, no two active objects have the same guid. If an object is replaced with a new object, then the guid persists. For example, if the _Move command moves an object, then the moved object inherits its guid from the starting object. If the Copy command copies an object, then the copy gets a new guid. This guid persists through file saving/opening operations. This function will not find grip objects.
public virtual T FindId(
id
ID of model component to search for.
)
inherited fromCommonComponentTable<T>
Reference to the rhino object with the objectId or null if no such object could be found.
FindId

FindName

#Since v6.0
Finds an InstanceDefinitionGeometry given its name.
public InstanceDefinitionGeometry FindName(
name
The name of the InstanceDefinitionGeometry to be searched.
)
An InstanceDefinitionGeometry, or null on error.

FindNameHash

#Since v6.0
Finds a InstanceDefinitionGeometry given its name hash.
public InstanceDefinitionGeometry FindNameHash(
nameHash
The name hash of the InstanceDefinitionGeometry to be searched.
)
An InstanceDefinitionGeometry, or null on error.

GetEnumerator

Returns the enumerator that yields all items.
public virtual IEnumerator<T> GetEnumerator()
inherited fromCommonComponentTable<T>