MeshFaceTypeAssistant

TypeAssistant<1>
public class MeshFaceTypeAssistant : TypeAssistant<MeshFace>
Type assistant for the MeshFace type.

Constructors

MeshFaceTypeAssistant

#
public MeshFaceTypeAssistant()

Properties

Constructors

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

Icon

#
public override IIcon Icon { get; }
Overrides: TypeAssistant<T>.Icon

IsReimplementation

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

Name

public string Name { get; }
Gets the parameter description associated with this type.
inherited fromTypeAssistant<T>
Implements: Name

ReimplementationBase

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

Type

public Type Type { get; }
Gets the type associated with this assistant.
inherited fromTypeAssistant<T>
Implements: Type

ZupportsArea

public bool ZupportsArea { get; }
Gets whether this type assistant has support for Area metrics.
inherited fromTypeAssistant<T>
Implements: ZupportsArea

ZupportsAreaCentroid

public bool ZupportsAreaCentroid { get; }
Gets whether this type assistant has support for Area centroid metrics.
inherited fromTypeAssistant<T>
Implements: ZupportsAreaCentroid

ZupportsBake

public bool ZupportsBake { get; }
Gets whether this type assistant has support for geometry baking.
inherited fromTypeAssistant<T>
Implements: ZupportsBake

ZupportsBoundingBox

public bool ZupportsBoundingBox { get; }
Gets whether this type assistant has support for BoundingBox metrics.
inherited fromTypeAssistant<T>
Implements: ZupportsBoundingBox

ZupportsClosestPoint

public bool ZupportsClosestPoint { get; }
Gets whether this type assistant has support for closest point resolution.
inherited fromTypeAssistant<T>
Implements: ZupportsClosestPoint

ZupportsDeform

public bool ZupportsDeform { get; }
Gets whether this type assistant has support for spatial morphs.
inherited fromTypeAssistant<T>
Implements: ZupportsDeform

ZupportsDraw

public bool ZupportsDraw { get; }
Gets whether this type assistant has support for geometry display.
inherited fromTypeAssistant<T>
Implements: ZupportsDraw

ZupportsFurthestPoint

public bool ZupportsFurthestPoint { get; }
Gets whether this type assistant has support for furthest point resolution.
inherited fromTypeAssistant<T>
Implements: ZupportsFurthestPoint

ZupportsLength

public bool ZupportsLength { get; }
Gets whether this type assistant has support for Length metrics.
inherited fromTypeAssistant<T>
Implements: ZupportsLength

ZupportsPick

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

ZupportsReadWrite

public bool ZupportsReadWrite { get; }
Gets whether this assistant supports (de)serializing instances of T.
inherited fromTypeAssistant<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 TypeAssistant<T>.Format(T) and TypeAssistant<T>.Parse(string, string, Pear<T>) must be implemented.
inherited fromTypeAssistant<T>
Implements: ZupportsRoundTripping

ZupportsTransform

public bool ZupportsTransform { get; }
Gets whether this type assistant has support for transformations.
inherited fromTypeAssistant<T>
Implements: ZupportsTransform

ZupportsTransformBox

public bool ZupportsTransformBox { get; }
Gets whether this type assistant has support for aligned BoundingBox metrics.
inherited fromTypeAssistant<T>
Implements: ZupportsTransformBox

ZupportsVolume

public bool ZupportsVolume { get; }
Gets whether this type assistant has support for Volume metrics.
inherited fromTypeAssistant<T>
Implements: ZupportsVolume

ZupportsVolumeCentroid

public bool ZupportsVolumeCentroid { get; }
Gets whether this type assistant has support for Volume centroid metrics.
inherited fromTypeAssistant<T>
Implements: ZupportsVolumeCentroid

Methods

Area

public virtual bool Area(T instance, out double area)
Measure the area of an instance.
inherited fromTypeAssistant<T>
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.
inherited fromTypeAssistant<T>
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.
inherited fromTypeAssistant<T>
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.
inherited fromTypeAssistant<T>
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 override MeshFace Copy(MeshFace instance)
Parameters:
instance (MeshFace)
Overrides: TypeAssistant<T>.Copy

CreateComparer

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

Deform

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

DescribePrimary

#
public override string DescribePrimary(Pear<MeshFace> pear)
Parameters:
pear (Pear<MeshFace>)
Overrides: TypeAssistant<T>.DescribePrimary

DescribeSecondary

#
public override string DescribeSecondary(Pear<MeshFace> pear)
Parameters:
pear (Pear<MeshFace>)
Overrides: TypeAssistant<T>.DescribeSecondary

Draw

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

Format

#
public override string Format(MeshFace instance)
Parameters:
instance (MeshFace)
Overrides: TypeAssistant<T>.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.
inherited fromTypeAssistant<T>
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

Hash

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

HashUsingWriteMethod

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

Length

#
public override bool Length(MeshFace instance, out double length)
Parameters:
instance (MeshFace)
length (out double)
Overrides: TypeAssistant<T>.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.
inherited fromTypeAssistant<T>
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.
inherited fromTypeAssistant<T>
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 override Result<MeshFace> Parse(string constructor, string text, Pear<MeshFace> existing)
Parameters:
constructor (string)
text (string)
existing (Pear<MeshFace>)
Overrides: TypeAssistant<T>.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.
inherited fromTypeAssistant<T>
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 override bool Read(IReader reader, Name location, out MeshFace instance)
Parameters:
reader (IReader)
location (Name)
instance (out MeshFace)
Overrides: TypeAssistant<T>.Read

RelinkMetaDataFromUserStrings

protected MetaData RelinkMetaDataFromUserStrings(MetaData metaOriginal, NameValueCollection userStrings, bool aggressive = true)
Utility method for updating metadata from userstrings after relinking a value.
inherited fromTypeAssistant<T>
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.
inherited fromTypeAssistant<T>
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 override bool Same(MeshFace a, MeshFace b)
Parameters:
a (MeshFace)
b (MeshFace)
Overrides: TypeAssistant<T>.Same

Show

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

Sort

#
public override int Sort(MeshFace a, MeshFace b)
Parameters:
a (MeshFace)
b (MeshFace)
Overrides: TypeAssistant<T>.Sort

Test

#
public override bool Test(MeshFace instance, out string invalidReason)
Parameters:
instance (MeshFace)
invalidReason (out string)
Overrides: TypeAssistant<T>.Test

Test

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

Text

#
public override Prose.Text Text(MeshFace instance)
Parameters:
instance (MeshFace)
Overrides: TypeAssistant<T>.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.
inherited fromTypeAssistant<T>
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.
inherited fromTypeAssistant<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.
inherited fromTypeAssistant<T>
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.
inherited fromTypeAssistant<T>
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.
inherited fromTypeAssistant<T>
Parameters:
instance (T)Instance to measure.
volume (out double)Measured volume.
centroid (out Point3d)Volume centroid.
Returns: Success or failure.
Implements: VolumeCentroid

Write

#
public override bool Write(IWriter writer, Name location, MeshFace instance)
Parameters:
writer (IWriter)
location (Name)
instance (MeshFace)
Overrides: TypeAssistant<T>.Write