VectorTypeAssistant

TypeAssistant<1>
public class VectorTypeAssistant : TypeAssistant<Vector3d>
Type assistant for the Rhino.Geometry.Point3d type.

Constructors

VectorTypeAssistant

#
public VectorTypeAssistant()

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 override bool Area(Vector3d instance, out double area)
Parameters:
instance (Vector3d)
area (out double)
Overrides: TypeAssistant<T>.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 Vector3d Copy(Vector3d instance)
Parameters:
instance (Vector3d)
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<Vector3d> pear)
Parameters:
pear (Pear<Vector3d>)
Overrides: TypeAssistant<T>.DescribePrimary

DescribeSecondary

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

Draw

#
public override void Draw(Pear<Vector3d> pear, DisplayBag bag)
Parameters:
pear (Pear<Vector3d>)
bag (DisplayBag)
Overrides: TypeAssistant<T>.Draw

Format

#
public override string Format(Vector3d instance)
Parameters:
instance (Vector3d)
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(Vector3d instance, out double length)
Parameters:
instance (Vector3d)
length (out double)
Overrides: TypeAssistant<T>.Length

ModifyBakeAttributes

#
public override ObjectAttributes ModifyBakeAttributes(Pear<Vector3d> pear, File3dm file, ObjectAttributes initial)
Parameters:
pear (Pear<Vector3d>)
file (File3dm)
initial (ObjectAttributes)
Overrides: TypeAssistant<T>.ModifyBakeAttributes

ModifyBakeAttributes

#
public override ObjectAttributes ModifyBakeAttributes(Pear<Vector3d> pear, RhinoDoc document, ObjectAttributes initial)
Parameters:
pear (Pear<Vector3d>)
document (RhinoDoc)
initial (ObjectAttributes)
Overrides: TypeAssistant<T>.ModifyBakeAttributes

Parse

#
public override Result<Vector3d> Parse(string constructor, string text, Pear<Vector3d> existing)
Parameters:
constructor (string)
text (string)
existing (Pear<Vector3d>)
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 Vector3d instance)
Parameters:
reader (IReader)
location (Name)
instance (out Vector3d)
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(Vector3d a, Vector3d b)
Parameters:
a (Vector3d)
b (Vector3d)
Overrides: TypeAssistant<T>.Same

Show

#
public override IValueDisplay Show(Pear<Vector3d> pear)
Parameters:
pear (Pear<Vector3d>)
Overrides: TypeAssistant<T>.Show

Sort

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

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

Test

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

Text

#
public override Prose.Text Text(Vector3d instance)
Parameters:
instance (Vector3d)
Overrides: TypeAssistant<T>.Text

ToGeometry

#
public override IEnumerable<GeometryBase> ToGeometry(Pear<Vector3d> pear)
Parameters:
pear (Pear<Vector3d>)
Overrides: TypeAssistant<T>.ToGeometry

Transform

#
public override object Transform(Vector3d instance, Transform matrix)
Parameters:
instance (Vector3d)
matrix (Transform)
Overrides: TypeAssistant<T>.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, Vector3d instance)
Parameters:
writer (IWriter)
location (Name)
instance (Vector3d)
Overrides: TypeAssistant<T>.Write