TransformField

FieldReferences
public class TransformField : Field
Transform field value class

Properties

AutomaticRegisteredProperty

public bool AutomaticRegisteredProperty { get; set; }
inherited fromField

IsHiddenInAutoUI

When fields are used by the automatic UI, they can be hidden from it by calling this method.
public bool IsHiddenInAutoUI { get; set; }
inherited fromField

Key

Field name value string passed to the constructor
obsoleteThe Rhino.Render.Fields.Field.Key property is obsolete, use Name instead.
inherited fromField

Name

Field name value string passed to the constructor.
public string Name { get; }
inherited fromField

Tag

Gets or sets an object that contains data to associate with the field.
public object Tag { get; set; }
inherited fromField
An object that contains information that is associated with the field.

TextureAmountMax

Set Max value for Texture amount
public double TextureAmountMax { get; set; }
inherited fromField

TextureAmountMin

Set Min value for Texture amount
public double TextureAmountMin { get; set; }
inherited fromField

UseTextureAmount

True if 'texture amount' is in use, otherwise false. The 'texture amount' is represented as a numeric stepper in the UI. If true, then the stepper is shown. If false, then the stepper is hidden.
public bool UseTextureAmount { get; set; }
inherited fromField

UseTextureOn

True if 'texture on' is in use, otherwise false. In the UI 'texture on' is represented as a checkbox. If true then the checbox is shown. If false then the checkbox is not shown.
public bool UseTextureOn { get; set; }
inherited fromField

Value

#Since v5.1
Gets or sets the field value
public Transform Value { get; set; }

Methods

CreateCppPointer

protected void CreateCppPointer(
content,
key,
prompt,
initialValue,
isTextured,
treatAsLinear
)
inherited fromField

GetValue<T>

Parametrized version of GetValue calling appropriate ValueAs* methods.
public T GetValue<T>()
inherited fromField
Value of type T of the field

ValueAsBool

Return field value as a bool.
protected bool ValueAsBool()
inherited fromField
Returns field value as a bool.

ValueAsByteArray

Return field as a byte array.
protected byte[] ValueAsByteArray()
inherited fromField
Return field as a byte array.

ValueAsColor4f

Return field as a Rhino.Display.Color4f color value.
protected Color4f ValueAsColor4f()
inherited fromField
Return field as a Rhino.Display.Color4f color value.

ValueAsDateTime

Return field as a DateTime value.
protected DateTime ValueAsDateTime()
inherited fromField
Return field as a DateTime value.

ValueAsDouble

Return field value as a double precision number.
protected double ValueAsDouble()
inherited fromField
Return the field value as a double precision number.

ValueAsFloat

Return field value as floating point number.
protected float ValueAsFloat()
inherited fromField
Return the field value as an floating point number.

ValueAsGuid

Return field value as Guid.
protected Guid ValueAsGuid()
inherited fromField
Return the field value as an Guid.

ValueAsInt

Return field value as integer.
protected int ValueAsInt()
inherited fromField
Return the field value as an integer.

ValueAsObject

#Since v5.7
public override object ValueAsObject()

ValueAsPoint2d

Return field as a Rhino.Geometry.Point2d color value.
protected Point2d ValueAsPoint2d()
inherited fromField
Return field as a Rhino.Geometry.Point2d color value.

ValueAsPoint3d

Return field as a Rhino.Geometry.Point3d color value.
protected Point3d ValueAsPoint3d()
inherited fromField
Return field as a Rhino.Geometry.Point3d color value.

ValueAsPoint4d

Return field as a Rhino.Geometry.Point4d color value.
protected Point4d ValueAsPoint4d()
inherited fromField
Return field as a Rhino.Geometry.Point4d color value.

ValueAsString

Get field value as a string.
protected string ValueAsString()
inherited fromField
Returns the field value as a string if possible.

ValueAsTransform

Return field as a Rhino.Geometry.Transform color value.
protected Transform ValueAsTransform()
inherited fromField
Return field as a Rhino.Geometry.Transform color value.

ValueAsVector2d

Return field as a Rhino.Geometry.Vector2d color value.
protected Vector2d ValueAsVector2d()
inherited fromField
Return field as a Rhino.Geometry.Vector2d color value.

ValueAsVector3d

Return field as a Rhino.Geometry.Vector3d color value.
protected Vector3d ValueAsVector3d()
inherited fromField
Return field as a Rhino.Geometry.Vector3d color value.