TypeAssistant<T>

References
public abstract class TypeAssistant<T> : ITypeAssistant<T>
Fundamental abstract, generic implementation of ITypeAssistant. Inherit from this class if you wish to provide functionality for a specific type.
Type parameters:
TType to assist.

Constructors

TypeAssistant

#
protected TypeAssistant(string name)
Constructor for the base type assistant.
Parameters:
name (string)Name of type. Must be in lower-case, or rather the way it would appear in the middle of a sentence.

Fields

FormatMax

#
public static readonly NumberFormat FormatMax
A number format to be used for a high accuracy. If your formatted string contains only one number, this would be a good choice.

FormatMid

#
public static readonly NumberFormat FormatMid
A number format to be used for a medium accuracy. If your formatted string contains about 3 numbers, this would be a good choice.

FormatMin

#
public static readonly NumberFormat FormatMin
A number format to be used for a low accuracy. If your formatted string contains more than 4 numbers, this would be a good choice.

Properties

Constructors

#
public virtual IEnumerable<string> Constructors { get; }
Enumerate all defined constructors for this type.
Implements: Constructors

Icon

#
public virtual IIcon Icon { get; }
Gets the icon (if any) associated with this type.
Implements: Icon

IsReimplementation

#
public bool IsReimplementation { get; }
Gets whether or not this assistant is a type-safe re-implementation of a more generic assistant.
Implements: IsReimplementation

Name

#
public string Name { get; }
Gets the parameter description associated with this type.
Implements: Name

ReimplementationBase

#
public ITypeAssistant ReimplementationBase { get; }
Gets the base assistant (if any) this assistant is a re-implementation of.
Implements: ReimplementationBase

Type

#
public Type Type { get; }
Gets the type associated with this assistant.
Implements: Type

ZupportsArea

#
public bool ZupportsArea { get; }
Gets whether this type assistant has support for Area metrics.
Implements: ZupportsArea

ZupportsAreaCentroid

#
public bool ZupportsAreaCentroid { get; }
Gets whether this type assistant has support for Area centroid metrics.
Implements: ZupportsAreaCentroid

ZupportsBake

#
public bool ZupportsBake { get; }
Gets whether this type assistant has support for geometry baking.
Implements: ZupportsBake

ZupportsBoundingBox

#
public bool ZupportsBoundingBox { get; }
Gets whether this type assistant has support for BoundingBox metrics.
Implements: ZupportsBoundingBox

ZupportsClosestPoint

#
public bool ZupportsClosestPoint { get; }
Gets whether this type assistant has support for closest point resolution.
Implements: ZupportsClosestPoint

ZupportsDeform

#
public bool ZupportsDeform { get; }
Gets whether this type assistant has support for spatial morphs.
Implements: ZupportsDeform

ZupportsDraw

#
public bool ZupportsDraw { get; }
Gets whether this type assistant has support for geometry display.
Implements: ZupportsDraw

ZupportsFurthestPoint

#
public bool ZupportsFurthestPoint { get; }
Gets whether this type assistant has support for furthest point resolution.
Implements: ZupportsFurthestPoint

ZupportsLength

#
public bool ZupportsLength { get; }
Gets whether this type assistant has support for Length metrics.
Implements: ZupportsLength

ZupportsPick

#
public bool ZupportsPick { get; }
Gets whether the assistants supports UI for specifying new values. Note that if the Pick(Pear<T>, Pear<T>) method hasn't been overwritten but the ZupportsRoundTripping is true, then values can be specified using the Format(T) and Parse(string, string, Pear<T>) methods.
Implements: ZupportsPick

ZupportsReadWrite

#
public bool ZupportsReadWrite { get; }
Gets whether this assistant supports (de)serializing instances of T.
Implements: ZupportsReadWrite

ZupportsRoundTripping

#
public bool ZupportsRoundTripping { get; }
Gets whether this assistant supports round-tripping from T to string to T. For this to be true, both Format(T) and Parse(string, string, Pear<T>) must be implemented.
Implements: ZupportsRoundTripping

ZupportsTransform

#
public bool ZupportsTransform { get; }
Gets whether this type assistant has support for transformations.
Implements: ZupportsTransform

ZupportsTransformBox

#
public bool ZupportsTransformBox { get; }
Gets whether this type assistant has support for aligned BoundingBox metrics.
Implements: ZupportsTransformBox

ZupportsVolume

#
public bool ZupportsVolume { get; }
Gets whether this type assistant has support for Volume metrics.
Implements: ZupportsVolume

ZupportsVolumeCentroid

#
public bool ZupportsVolumeCentroid { get; }
Gets whether this type assistant has support for Volume centroid metrics.
Implements: ZupportsVolumeCentroid

Methods

Area

#
public virtual bool Area(T instance, out double area)
Measure the area of an instance.
Parameters:
instance (T)Instance to measure.
area (out double)Measured area.
Returns: Success or failure.
Implements: Area

AreaCentroid

#
public virtual bool AreaCentroid(T instance, out double area, out Point3d centroid)
Measure the area of an instance.
Parameters:
instance (T)Instance to measure.
area (out double)Measured area.
centroid (out Point3d)Area centroid.
Returns: Success or failure.
Implements: AreaCentroid

BoundingBox

#
public virtual BoundingBox BoundingBox(T instance)
Gets the world aligned boundingbox for an instance.
Parameters:
instance (T)Instance to measure.
Returns: BoundingBox.
Implements: BoundingBox

ClosestPoint

#
public virtual bool ClosestPoint(T instance, Point3d locus, out Point3d site)
Gets the point on an instance closest to a locus point.
Parameters:
instance (T)Instance to examine.
locus (Point3d)Locus (search) point.
site (out Point3d)Point on instance closest to locus.
Returns: Success or failure.
Implements: ClosestPoint

Copy

#
public abstract T Copy(T instance)
Create an exact duplicate of an instance.
Parameters:
instance (T)Instance to duplicate.
Returns: Duplicate.
Implements: Copy

CreateComparer

#
public IEqualityComparer<T> CreateComparer()
Create an equality comparer for this type. It depends on the implementation of Hash() and Same().

Deform

#
public virtual object Deform(T instance, SpaceMorph morph)
Morph an instance of T.
Parameters:
instance (T)Instance to morph.
morph (SpaceMorph)Morping class.
Returns: Morphed object.
Implements: Deform

DescribePrimary

#
public abstract string DescribePrimary(Pear<T> pear)
Give the primary description of a value. This does not need to yield a parsable string, the results are meant only for human consumption.
Parameters:
pear (Pear<T>)Pear to describe.
Implements: DescribePrimary

DescribeSecondary

#
public virtual string DescribeSecondary(Pear<T> pear)
Give the secondary description of a value. The secondary description may elaborate on the value. This method may always return null.
Parameters:
pear (Pear<T>)Pear th describe.
Implements: DescribeSecondary

Draw

#
public virtual void Draw(Pear<T> pear, DisplayBag bag)
Add a value to a display bag.
Parameters:
pear (Pear<T>)
bag (DisplayBag)
Implements: Draw

Format

#
public virtual string Format(T instance)
Format an instance partially so that it can be modified via text.
Parameters:
instance (T)Instance to format.
Implements: Format

FurthestPoint

#
public virtual bool FurthestPoint(T instance, Point3d locus, out Point3d site)
Gets the point on an instance furthest away from a locus point.
Parameters:
instance (T)Instance to examine.
locus (Point3d)Locus (search) point.
site (out Point3d)Point on instance furthest from locus.
Returns: Success or failure.
Implements: FurthestPoint
Explicit

ITypeAssistant.Area

#
bool ITypeAssistant.Area(object instance, out double area)
Parameters:
instance (object)
area (out double)
Implements: Area
Explicit

ITypeAssistant.AreaCentroid

#
bool ITypeAssistant.AreaCentroid(object instance, out double area, out Point3d centroid)
Parameters:
instance (object)
area (out double)
centroid (out Point3d)
Implements: AreaCentroid
Explicit

ITypeAssistant.BoundingBox

#
BoundingBox ITypeAssistant.BoundingBox(object instance)
Parameters:
instance (object)
Implements: BoundingBox
Explicit

ITypeAssistant.ClosestPoint

#
bool ITypeAssistant.ClosestPoint(object instance, Point3d locus, out Point3d site)
Parameters:
instance (object)
locus (Point3d)
site (out Point3d)
Implements: ClosestPoint
Explicit

ITypeAssistant.Copy

#
object ITypeAssistant.Copy(object instance)
Parameters:
instance (object)
Implements: Copy
Explicit

ITypeAssistant.Deform

#
object ITypeAssistant.Deform(object instance, SpaceMorph morph)
Parameters:
instance (object)
morph (SpaceMorph)
Implements: Deform
Explicit

ITypeAssistant.DescribePrimary

#
string ITypeAssistant.DescribePrimary(IPear pear)
Parameters:
pear (IPear)
Implements: DescribePrimary
Explicit

ITypeAssistant.DescribeSecondary

#
string ITypeAssistant.DescribeSecondary(IPear pear)
Parameters:
pear (IPear)
Implements: DescribeSecondary
Explicit

ITypeAssistant.Draw

#
void ITypeAssistant.Draw(IPear pear, DisplayBag bag)
Parameters:
pear (IPear)
bag (DisplayBag)
Implements: Draw
Explicit

ITypeAssistant.Format

#
string ITypeAssistant.Format(object instance)
Parameters:
instance (object)
Implements: Format
Explicit

ITypeAssistant.FurthestPoint

#
bool ITypeAssistant.FurthestPoint(object instance, Point3d locus, out Point3d site)
Parameters:
instance (object)
locus (Point3d)
site (out Point3d)
Implements: FurthestPoint
Explicit

ITypeAssistant.Hash

#
int ITypeAssistant.Hash(object instance)
Parameters:
instance (object)
Implements: Hash
Explicit

ITypeAssistant.Length

#
bool ITypeAssistant.Length(object instance, out double length)
Parameters:
instance (object)
length (out double)
Implements: Length
Explicit

ITypeAssistant.ModifyBakeAttributes

#
ObjectAttributes ITypeAssistant.ModifyBakeAttributes(IPear pear, File3dm file, ObjectAttributes initial)
Parameters:
pear (IPear)
file (File3dm)
initial (ObjectAttributes)
Implements: ModifyBakeAttributes
Explicit

ITypeAssistant.ModifyBakeAttributes

#
ObjectAttributes ITypeAssistant.ModifyBakeAttributes(IPear pear, RhinoDoc document, ObjectAttributes initial)
Parameters:
pear (IPear)
document (RhinoDoc)
initial (ObjectAttributes)
Implements: ModifyBakeAttributes
Explicit

ITypeAssistant.Parse

#
IResult ITypeAssistant.Parse(string constructor, string text, IPear existing)
Parameters:
constructor (string)
text (string)
existing (IPear)
Implements: Parse
Explicit

ITypeAssistant.Pick

#
bool ITypeAssistant.Pick(IPear existing, out IPear pear)
Parameters:
existing (IPear)
pear (out IPear)
Implements: Pick
Explicit

ITypeAssistant.Read

#
bool ITypeAssistant.Read(IReader reader, Name location, out object instance)
Parameters:
reader (IReader)
location (Name)
instance (out object)
Implements: Read
Explicit

ITypeAssistant.Same

#
bool ITypeAssistant.Same(object a, object b)
Parameters:
a (object)
b (object)
Implements: Same
Explicit

ITypeAssistant.Show

#
IValueDisplay ITypeAssistant.Show(IPear pear)
Parameters:
pear (IPear)
Implements: Show
Explicit

ITypeAssistant.Sort

#
int ITypeAssistant.Sort(object a, object b)
Parameters:
a (object)
b (object)
Implements: Sort
Explicit

ITypeAssistant.Test

#
bool ITypeAssistant.Test(object instance, out string invalidReason)
Parameters:
instance (object)
invalidReason (out string)
Implements: Test
Explicit

ITypeAssistant.Test

#
bool ITypeAssistant.Test(object instance)
Parameters:
instance (object)
Implements: Test
Explicit

ITypeAssistant.Text

#
Prose.Text ITypeAssistant.Text(object instance)
Parameters:
instance (object)
Implements: Text
Explicit

ITypeAssistant.ToGeometry

#
IEnumerable<GeometryBase> ITypeAssistant.ToGeometry(IPear pear)
Parameters:
pear (IPear)
Implements: ToGeometry
Explicit

ITypeAssistant.Transform

#
object ITypeAssistant.Transform(object instance, Transform matrix)
Parameters:
instance (object)
matrix (Transform)
Implements: Transform
Explicit

ITypeAssistant.TransformBox

#
BoundingBox ITypeAssistant.TransformBox(object instance, Transform transformation)
Parameters:
instance (object)
transformation (Transform)
Implements: TransformBox
Explicit

ITypeAssistant.Volume

#
bool ITypeAssistant.Volume(object instance, out double volume)
Parameters:
instance (object)
volume (out double)
Implements: Volume
Explicit

ITypeAssistant.VolumeCentroid

#
bool ITypeAssistant.VolumeCentroid(object instance, out double volume, out Point3d centroid)
Parameters:
instance (object)
volume (out double)
centroid (out Point3d)
Implements: VolumeCentroid
Explicit

ITypeAssistant.Write

#
bool ITypeAssistant.Write(IWriter writer, Name location, object instance)
Parameters:
writer (IWriter)
location (Name)
instance (object)
Implements: Write

Hash

#
public virtual int Hash(T instance)
Hash an instance of the object. The default implementation calls GetHash() on the instance.
Parameters:
instance (T)
Implements: Hash

HashUsingWriteMethod

#
protected int HashUsingWriteMethod(T instance)
Utility method for hashing a value based on the Write() implementation.
Parameters:
instance (T)

Length

#
public virtual bool Length(T instance, out double length)
Measure the length of an instance.
Parameters:
instance (T)Instance to measure.
length (out double)Measured length.
Returns: Success or failure.
Implements: Length

ModifyBakeAttributes

#
public virtual ObjectAttributes ModifyBakeAttributes(Pear<T> pear, File3dm file, ObjectAttributes initial)
By overriding this method, the type implementor may add modifications to the attributes of objects baked to Rhino files. For example, vectors when baked require an arrowhead to be set at the curve end, and this must be specified via the object attributes.
Parameters:
pear (Pear<T>)The pear associated with the attributes.
file (File3dm)The Rhino 3dm file into which the geometry will be baked.
initial (ObjectAttributes)The attributes to be used.
Returns: Modified attributes.

ModifyBakeAttributes

#
public virtual ObjectAttributes ModifyBakeAttributes(Pear<T> pear, RhinoDoc document, ObjectAttributes initial)
By overriding this method, the type implementor may add modifications to the attributes of objects baked to Rhino documents. For example, vectors when baked require an arrowhead to be set at the curve end, and this must be specified via the object attributes.
Parameters:
pear (Pear<T>)The pear associated with the attributes.
document (RhinoDoc)The Rhino document into which the geometry will be baked.
initial (ObjectAttributes)The attributes to be used.
Returns: Modified attributes.
Implements: ModifyBakeAttributes

Parse

#
public virtual Result<T> Parse(string constructor, string text, Pear<T> existing)
Parse a (possibly partial) description of a value.
Parameters:
constructor (string)Constructor name, if applicable.
text (string)Text to parse.
existing (Pear<T>)Pre-existing instance to modify, may be null.
Implements: Parse

Pick

#
public virtual bool Pick(Pear<T> existing, out Pear<T> pear)
Ask the user to specify (or pick) a new value. When this method is invoked, it is assumed that it will start a RhinoGet operation or otherwise pop some kind of UI on the screen.
Parameters:
existing (Pear<T>)Existing value to be overwritten, if any.
pear (out Pear<T>)Pear which was picked.
Returns: True if a value was picked.
Implements: Pick

Read

#
public virtual bool Read(IReader reader, Name location, out T instance)
Read an instance from a GrasshopperIO archive.
Parameters:
reader (IReader)Deserialization reader.
location (Name)Location of data. Whether the location points to an item or child node is up to the implementer to decide.
instance (out T)Deserialized instance.
Returns: Success or failure.
Implements: Read

RelinkMetaDataFromUserStrings

#
protected MetaData RelinkMetaDataFromUserStrings(MetaData metaOriginal, NameValueCollection userStrings, bool aggressive = true)
Utility method for updating metadata from userstrings after relinking a value.
Parameters:
metaOriginal (MetaData)Meta data of original value.
userStrings (NameValueCollection)User strings collection.
aggressive (bool = true)If true, all original data except the 'Rhino.Id' and 'Rhino.IdOrigin' will be wiped.
Returns: Updated metadata.

RelinkMetaDataFromUserStrings

#
protected MetaData RelinkMetaDataFromUserStrings(MetaData metaOriginal, ObjectAttributes attributes, bool aggressive = true)
Utility method for updating metadata from userstrings after relinking a value.
Parameters:
metaOriginal (MetaData)Meta data of original value.
attributes (ObjectAttributes)Rhino object attributes.
aggressive (bool = true)If true, all original data except the 'Rhino.Id', 'Rhino.IdOrigin', and 'Rhino.Index' will be wiped.
Returns: Updated metadata.

Same

#
public virtual bool Same(T a, T b)
Compare two instances for equality. If not implemented, this method will revert to Write/Read comparison, and then Text comparisons.
Parameters:
a (T)
b (T)
Implements: Same

Show

#
public virtual IValueDisplay Show(Pear<T> pear)
Create a Grasshopper display proxy.
Parameters:
pear (Pear<T>)(value, meta) pear to display.
Returns: Display proxy.
Implements: Show

Sort

#
public virtual int Sort(T a, T b)
Compare the sort order of two instances. If not implemented, this will resort to the default comparer as provided by System.Collections.Generic.Comparer.Default
Parameters:
a (T)
b (T)
Implements: Sort

Test

#
public virtual bool Test(T instance, out string invalidReason)
Determine the validity of an instance. This method always returns true unless overridden.
Parameters:
instance (T)Instance.
invalidReason (out string)If the instance is not valid, the problem description will be returned here.
Returns: True if the instance is valid, false if otherwise.
Implements: Test

Test

#
public bool Test(T instance)
Determine the validity of an instance.
Parameters:
instance (T)Instance.
Returns: True if the instance is valid, false if otherwise.
Implements: Test

Text

#
public virtual Prose.Text Text(T instance)
Create a string which can function as a sorting key for this value. If the value is null, a TypeAssistantServer.NullKey must be returned.
Parameters:
instance (T)Instance.
Returns: String to be used as a sorting key.
Implements: Text

ToGeometry

#
public virtual IEnumerable<GeometryBase> ToGeometry(Pear<T> pear)
Convert a pear into a collection of Rhino compliant geometries. This is used primarily for the standard baking of geometric data.
Parameters:
pear (Pear<T>)Pear to convert.
Returns: An collection of zero or more Rhino document compliant shapes.
Implements: ToGeometry

Transform

#
public virtual object Transform(T instance, Transform matrix)
Transform an instance of T.
Parameters:
instance (T)Instance to transform.
matrix (Transform)Transformation matrix.
Returns: Transformed object.
Implements: Transform

TransformBox

#
public virtual BoundingBox TransformBox(T instance, Transform transformation)
Gets the transformation aligned boundingbox for an instance.
Parameters:
instance (T)
transformation (Transform)
Returns: BoundingBox.
Implements: TransformBox

Volume

#
public virtual bool Volume(T instance, out double volume)
Measure the volume of an instance.
Parameters:
instance (T)Instance to measure.
volume (out double)Measured volume.
Returns: Success or failure.
Implements: Volume

VolumeCentroid

#
public virtual bool VolumeCentroid(T instance, out double volume, out Point3d centroid)
Measure the volume of an instance.
Parameters:
instance (T)Instance to measure.
volume (out double)Measured volume.
centroid (out Point3d)Volume centroid.
Returns: Success or failure.
Implements: VolumeCentroid

Write

#
public virtual bool Write(IWriter writer, Name location, T instance)
Write an instance to a GrasshopperIO archive.
Parameters:
writer (IWriter)Serialization writer.
location (Name)Location of data. Whether the location points to an item or child node is up to the implementer to decide.
instance (T)Instance to write.
Returns: Success or failure.
Implements: Write