PlaneTypeAssistant

TypeAssistant<1>
public class PlaneTypeAssistant : TypeAssistant<Plane>
Type assistant for the Plane type.

Constructors

PlaneTypeAssistant

#
public PlaneTypeAssistant()

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

AlignPlaneWithWorld

#
public static bool AlignPlaneWithWorld(Plane plane, out Plane aligned)
Rotate a plane so that its X and Y axes are aligned with world axes if the normal is already aligned with world axes.
Parameters:
plane (Plane)
aligned (out Plane)

Area

#
public override bool Area(Plane instance, out double area)
Parameters:
instance (Plane)
area (out double)
Overrides: TypeAssistant<T>.Area

AreaCentroid

#
public override bool AreaCentroid(Plane instance, out double area, out Point3d centroid)
Parameters:
instance (Plane)
area (out double)
centroid (out Point3d)
Overrides: TypeAssistant<T>.AreaCentroid

BoundingBox

#
public override BoundingBox BoundingBox(Plane instance)
Parameters:
instance (Plane)
Overrides: TypeAssistant<T>.BoundingBox

ClosestPoint

#
public override bool ClosestPoint(Plane instance, Point3d locus, out Point3d site)
Parameters:
instance (Plane)
locus (Point3d)
site (out Point3d)
Overrides: TypeAssistant<T>.ClosestPoint

Copy

#
public override Plane Copy(Plane instance)
Parameters:
instance (Plane)
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 override object Deform(Plane instance, SpaceMorph morph)
Parameters:
instance (Plane)
morph (SpaceMorph)
Overrides: TypeAssistant<T>.Deform

DescribePrimary

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

DescribeSecondary

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

Draw

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

Format

#
public override string Format(Plane instance)
Parameters:
instance (Plane)
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 virtual bool Length(T instance, out double length)
Measure the length of an instance.
inherited fromTypeAssistant<T>
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.
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<Plane> Parse(string constructor, string text, Pear<Plane> existing)
Parameters:
constructor (string)
text (string)
existing (Pear<Plane>)
Overrides: TypeAssistant<T>.Parse

Pick

#
public override bool Pick(Pear<Plane> existing, out Pear<Plane> pear)
Parameters:
existing (Pear<Plane>)
pear (out Pear<Plane>)
Overrides: TypeAssistant<T>.Pick

Read

#
public override bool Read(IReader reader, Name location, out Plane instance)
Parameters:
reader (IReader)
location (Name)
instance (out Plane)
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(Plane a, Plane b)
Parameters:
a (Plane)
b (Plane)
Overrides: TypeAssistant<T>.Same

Show

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

Sort

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

Test

#
public override bool Test(Plane instance, out string invalidReason)
Parameters:
instance (Plane)
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(Plane instance)
Parameters:
instance (Plane)
Overrides: TypeAssistant<T>.Text

ToGeometry

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

Transform

#
public override object Transform(Plane instance, Transform matrix)
Parameters:
instance (Plane)
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 override bool Volume(Plane instance, out double volume)
Parameters:
instance (Plane)
volume (out double)
Overrides: TypeAssistant<T>.Volume

VolumeCentroid

#
public override bool VolumeCentroid(Plane instance, out double volume, out Point3d centroid)
Parameters:
instance (Plane)
volume (out double)
centroid (out Point3d)
Overrides: TypeAssistant<T>.VolumeCentroid

Write

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