Extract a set of meta data from a Rhino user dictionary. This is the inverse of Embed(MetaData, ArchivableDictionary); only entries stored under a GH2: prefixed key are considered. Note that functions and gradients cannot survive a round-trip, they come back as text.

Parameters:

userDictionary (ArchivableDictionary)

HasReferenceId

#Example

public static bool HasReferenceId(this MetaData data, out Guid id)

Gets whether meta data has a Rhino reference ID. This method does not check the validity of the id, just whether it has been defined. Because this is an extension method, it can be called on null meta data.

Parameters:

data (MetaData)
id (out Guid)

HasReferenceId

#Example

public static bool HasReferenceId(this MetaData data)

Gets whether meta data has a Rhino reference ID. This method does not check the validity of the id, just whether it has been defined.

Parameters:

data (MetaData)

HasVectorAnchor

#Example

public static bool HasVectorAnchor(this MetaData data, out Point3d anchor)

Gets whether meta data has a vector anchor point.

Parameters:

data (MetaData)
anchor (out Point3d)

HasVectorAnchor

#Example

public static bool HasVectorAnchor(this MetaData data)

Gets whether meta data has a vector anchor point.

Parameters:

data (MetaData)

IsNullOrEmpty

#Example

public static bool IsNullOrEmpty(this MetaData meta)

Test whether meta data is null or empty.

Parameters:

meta (MetaData)

PerformCompare

#Example

public static MetaDataComparison PerformCompare(this MetaData meta, string pattern, Operator op, Angle constant)

Check whether meta data contains a key which matches the given name, and whose value matches a given comparison.

Parameters:

meta (MetaData)
pattern (string)
op (Operator)
constant (Angle)

Returns: True if at least one key matches the pattern.

PerformCompare

#Example

public static MetaDataComparison PerformCompare(this MetaData meta, string pattern, Operator op, BigInteger constant)

Check whether meta data contains a key which matches the given name, and whose value matches a given comparison.

Parameters:

meta (MetaData)
pattern (string)
op (Operator)
constant (BigInteger)

Returns: True if at least one key matches the pattern.

PerformCompare

#Example

public static MetaDataComparison PerformCompare(this MetaData meta, string pattern, Operator op, bool constant)

Check whether meta data contains a key which matches the given name, and whose value matches a given comparison.

Parameters:

meta (MetaData)
pattern (string)
op (Operator)
constant (bool)

Returns: True if at least one key matches the pattern.

PerformCompare

#Example

public static MetaDataComparison PerformCompare(this MetaData meta, string pattern, Operator op, DateTime constant)

Check whether meta data contains a key which matches the given name, and whose value matches a given comparison.

Parameters:

meta (MetaData)
pattern (string)
op (Operator)
constant (DateTime)

Returns: True if at least one key matches the pattern.

PerformCompare

#Example

public static MetaDataComparison PerformCompare(this MetaData meta, string pattern, Operator op, double constant)

Check whether meta data contains a key which matches the given name, and whose value matches a given comparison.

Parameters:

meta (MetaData)
pattern (string)
op (Operator)
constant (double)

Returns: True if at least one key matches the pattern.

PerformCompare

#Example

public static MetaDataComparison PerformCompare(this MetaData meta, string pattern, Operator op, Guid constant)

Check whether meta data contains a key which matches the given name, and whose value matches a given comparison.

Parameters:

meta (MetaData)
pattern (string)
op (Operator)
constant (Guid)

Returns: True if at least one key matches the pattern.

PerformCompare

#Example

public static MetaDataComparison PerformCompare(this MetaData meta, string pattern, Operator op, int constant)

Check whether meta data contains a key which matches the given name, and whose value matches a given comparison.

Parameters:

meta (MetaData)
pattern (string)
op (Operator)
constant (int)

Returns: True if at least one key matches the pattern.

PerformCompare

#Example

public static MetaDataComparison PerformCompare(this MetaData meta, string pattern, Operator op, Interval constant)

Check whether meta data contains a key which matches the given pattern, and whose value matches a given comparison.

Parameters:

meta (MetaData)
pattern (string)
op (Operator)
constant (Interval)

Returns: True if at least one key matches the pattern.

PerformCompare

#Example

public static MetaDataComparison PerformCompare(this MetaData meta, string pattern, Operator op, MetaValue value)

Resolve a comparison with a meta value.

Parameters:

meta (MetaData)
pattern (string)
op (Operator)
value (MetaValue)

PerformCompare

#Example

public static MetaDataComparison PerformCompare(this MetaData meta, string pattern, Operator op, Plane constant)

Check whether meta data contains a key which matches the given name, and whose value matches a given comparison.

Parameters:

meta (MetaData)
pattern (string)
op (Operator)
constant (Plane)

Returns: True if at least one key matches the pattern.

PerformCompare

#Example

public static MetaDataComparison PerformCompare(this MetaData meta, string pattern, Operator op, Point3d constant)

Check whether meta data contains a key which matches the given name, and whose value matches a given comparison.

Parameters:

meta (MetaData)
pattern (string)
op (Operator)
constant (Point3d)

Returns: True if at least one key matches the pattern.

PerformCompare

#Example

public static MetaDataComparison PerformCompare(this MetaData meta, string pattern, Operator op, string constant)

Check whether meta data contains a key which matches the given name, and whose value matches a given comparison.

Parameters:

meta (MetaData)
pattern (string)
op (Operator)
constant (string)

Returns: True if at least one key matches the pattern.

PerformCompare

#Example

public static MetaDataComparison PerformCompare(this MetaData meta, string pattern, Operator op, TimeSpan constant)

Check whether meta data contains a key which matches the given name, and whose value matches a given comparison.

Parameters:

meta (MetaData)
pattern (string)
op (Operator)
constant (TimeSpan)

Returns: True if at least one key matches the pattern.

PerformCompare

#Example

public static MetaDataComparison PerformCompare(this MetaData meta, string pattern, Operator op, Transform constant)

Check whether meta data contains a key which matches the given name, and whose value matches a given comparison.

Parameters:

meta (MetaData)
pattern (string)
op (Operator)
constant (Transform)

Returns: True if at least one key matches the pattern.

PerformCompare

#Example

public static MetaDataComparison PerformCompare(this MetaData meta, string pattern, Operator op, Vector3d constant)

Check whether meta data contains a key which matches the given name, and whose value matches a given comparison.

Parameters:

meta (MetaData)
pattern (string)
op (Operator)
constant (Vector3d)

Returns: True if at least one key matches the pattern.

PerformCompare

#Example

public static MetaDataComparison PerformCompare(this MetaData meta, string pattern)

Check whether meta data contains a key which matches the given name.

Parameters:

meta (MetaData)	Meta data, may be null.
pattern (string)	Key pattern, may contain wildcards.

Returns: True if at least one key matches the pattern.

Remove

#Example

public static MetaData[] Remove(this MetaData[] array, params MetaName[] names)

Remove the specified names from all metadata in an array.

Parameters:

array (MetaData[])	Array to parse.
names (params MetaName[])	Names to remove.

Returns: Either the original array if no values were removed, a modified array if some values were removed, or null if all values were removed.

Resolve

#Example

public static bool Resolve(this MetaData meta, string pattern, out BigInteger value)

Check whether meta data contains a key which matches the given pattern, and output the associated value.

Parameters:

meta (MetaData)	Meta data, may be null.
pattern (string)	Key pattern.
value (out BigInteger)	Value associated with key.

Returns: True if a key was found.

Resolve

#Example

public static bool Resolve(this MetaData meta, string pattern, out bool value)

Check whether meta data contains a key which matches the given pattern, and output the associated value.

Parameters:

meta (MetaData)	Meta data, may be null.
pattern (string)	Key pattern.
value (out bool)	Value associated with key.

Returns: True if a key was found.

Resolve

#Example

public static bool Resolve(this MetaData meta, string pattern, out byte[] value)

Check whether meta data contains a key which matches the given pattern, and output the associated value.

Parameters:

meta (MetaData)	Meta data, may be null.
pattern (string)	Key pattern.
value (out byte[])	Value associated with key.

Returns: True if a key was found.

Resolve

#Example

public static bool Resolve(this MetaData meta, string pattern, out Color value)

Check whether meta data contains a key which matches the given pattern, and output the associated value.

Parameters:

meta (MetaData)	Meta data, may be null.
pattern (string)	Key pattern.
value (out Color)	Value associated with key.

Returns: True if a key was found.

Resolve

#Example

public static bool Resolve(this MetaData meta, string pattern, out Colour value)

Check whether meta data contains a key which matches the given pattern, and output the associated value.

Parameters:

meta (MetaData)	Meta data, may be null.
pattern (string)	Key pattern.
value (out Colour)	Value associated with key.

Returns: True if a key was found.

Resolve

#Example

public static bool Resolve(this MetaData meta, string pattern, out DateTime value)

Check whether meta data contains a key which matches the given pattern, and output the associated value.

Parameters:

meta (MetaData)	Meta data, may be null.
pattern (string)	Key pattern.
value (out DateTime)	Value associated with key.

Returns: True if a key was found.

Resolve

#Example

public static bool Resolve(this MetaData meta, string pattern, out double value)

Check whether meta data contains a key which matches the given pattern, and output the associated value.

Parameters:

meta (MetaData)	Meta data, may be null.
pattern (string)	Key pattern.
value (out double)	Value associated with key.

Returns: True if a key was found.

Resolve

#Example

public static bool Resolve(this MetaData meta, string pattern, out Guid value)

Check whether meta data contains a key which matches the given pattern, and output the associated value.

Parameters:

meta (MetaData)	Meta data, may be null.
pattern (string)	Key pattern.
value (out Guid)	Value associated with key.

Returns: True if a key was found.

Resolve

#Example

public static bool Resolve(this MetaData meta, string pattern, out int value)

Check whether meta data contains a key which matches the given pattern, and output the associated value.

Parameters:

meta (MetaData)	Meta data, may be null.
pattern (string)	Key pattern.
value (out int)	Value associated with key.

Returns: True if a key was found.

Resolve

#Example

public static bool Resolve(this MetaData meta, string pattern, out MetaValue value)

Check whether meta data contains a key which matches the given pattern, and output the associated value.

Parameters:

meta (MetaData)	Meta data, may be null.
pattern (string)	Key pattern.
value (out MetaValue)	Value associated with key.

Returns: True if a key was found.

Resolve

#Example

public static bool Resolve(this MetaData meta, string pattern, out Plane value)

Check whether meta data contains a key which matches the given pattern, and output the associated value.

Parameters:

meta (MetaData)	Meta data, may be null.
pattern (string)	Key pattern.
value (out Plane)	Value associated with key.

Returns: True if a key was found.

Resolve

#Example

public static bool Resolve(this MetaData meta, string pattern, out Point3d value)

Check whether meta data contains a key which matches the given pattern, and output the associated value.

Parameters:

meta (MetaData)	Meta data, may be null.
pattern (string)	Key pattern.
value (out Point3d)	Value associated with key.

Returns: True if a key was found.

Resolve

#Example

public static bool Resolve(this MetaData meta, string pattern, out string value)

Check whether meta data contains a key which matches the given pattern, and output the associated value.

Parameters:

meta (MetaData)	Meta data, may be null.
pattern (string)	Key pattern.
value (out string)	Value associated with key.

Returns: True if a key was found.

Resolve

#Example

public static bool Resolve(this MetaData meta, string pattern, out TimeSpan value)

Check whether meta data contains a key which matches the given pattern, and output the associated value.

Parameters:

meta (MetaData)	Meta data, may be null.
pattern (string)	Key pattern.
value (out TimeSpan)	Value associated with key.

Returns: True if a key was found.

Resolve

#Example

public static bool Resolve(this MetaData meta, string pattern, out Transform value)

Check whether meta data contains a key which matches the given pattern, and output the associated value.

Parameters:

meta (MetaData)	Meta data, may be null.
pattern (string)	Key pattern.
value (out Transform)	Value associated with key.

Returns: True if a key was found.

Resolve

#Example

public static bool Resolve(this MetaData meta, string pattern, out Vector3d value)

Check whether meta data contains a key which matches the given pattern, and output the associated value.

Parameters:

meta (MetaData)	Meta data, may be null.
pattern (string)	Key pattern.
value (out Vector3d)	Value associated with key.

Returns: True if a key was found.

ToMetaData

#Example

public static MetaData ToMetaData(this NameValueCollection userStrings, List<Message> messages = null)

Harvest metadata from Rhino userstrings. Note that all returned values are marked as 'transient' which is an internal state that allows Grasshopper to remove them in the case of an update.

Parameters:

userStrings (NameValueCollection)
messages (List<Message> = null)

TryGet<T>

#Example

public static bool TryGet<T>(this MetaData meta, MetaName name, MetaName alternate, out T value)

Try to get the value with the given name. If the name is defined but associated with a value type other than T, a widening conversion will be performed if possible.

Parameters:

meta (MetaData)	Meta data to operate on.
name (MetaName)	Name to retrieve.
alternate (MetaName)	Alternate fallback name.
value (out T)	Value will be returned here.

Returns: True if value was found, false if name is undefined or if the type doesn't match.

TryGet<T>

#Example

public static bool TryGet<T>(this MetaData meta, MetaName name, out T value)

Try to get the value with the given name. If the name is defined but associated with a value type other than T, a widening conversion will be performed if possible.

Parameters:

meta (MetaData)	Meta data to operate on.
name (MetaName)	Name to retrieve.
value (out T)	Value will be returned here.

Returns: True if value was found, false if name is undefined or if the type doesn't match.

TryGetMatch

#Example

public static bool TryGetMatch(this MetaData data, string namePattern, out MetaValue value)

Try and find the first value whose name matches the given pattern.

Parameters:

data (MetaData)
namePattern (string)
value (out MetaValue)

WithoutReferenceId

#Example

public static MetaData WithoutReferenceId(this MetaData data, bool retainUnderAlternate)

Remove reference id data from meta data.

Parameters:

data (MetaData)	Data to remove from. May be null.
retainUnderAlternate (bool)	If true, and the metadata contains an Id value, it will be moved into an alternate name.

Returns: Meta data without reference id.

WithoutTransientMetaData

#Example

public static IPear WithoutTransientMetaData(this IPear pear, TransientMetaData filter)

Remove the transient meta data entries which are not supposed to be copied to offspring values.

Parameters:

pear (IPear)	Pear to operate on, may be null.
filter (TransientMetaData)	Transient data to remove.

WithoutTransientMetaData<T>

#Example

public static Pear<T> WithoutTransientMetaData<T>(this Pear<T> pear, TransientMetaData filter)

Remove the transient meta data entries which are not supposed to be copied to offspring values.

Parameters:

pear (Pear<T>)	Pear to operate on, may be null.
filter (TransientMetaData)	Transient data to remove.

WithReferenceId

#Example

public static MetaData WithReferenceId(this MetaData data, Guid id)

Add a reference id to meta data.

Parameters:

data (MetaData)	Data to append to. May be null.
id (Guid)	Id to add.

Returns: Meta data with reference id.

Zip<T>

#Example

public static IEnumerable<Pear<T>> Zip<T>(this (IEnumerable<T> items, IEnumerable<MetaData> metaData) contents)

Zip an item and a meta data collection into a Pair collection.

Parameters:

contents ((IEnumerable<T> items, IEnumerable<MetaData> metaData))

Tuple containing the item and meta data enumerations.

Returns: Pair enumeration.

Zip<T>

#Example

public static IEnumerable<Pear<T>> Zip<T>(this IEnumerable<T> items, IEnumerable<MetaData> metaData)

Zip an item and a meta data collection into a Pair collection.

Parameters:

items (IEnumerable<T>)	Collection of item values.
metaData (IEnumerable<MetaData>)	Collection of meta data values.

Returns: Pair enumeration.