Field

Public Class

Generic data fields used to add publicly accessible properties to RenderContent.FieldDictionary. These should be created by calling a FieldDictaionary.Add() method on a Render content object. These are allocated after the RenderContent object’s C++ object is created and added to the underlying C++ objects content dictionary, who ever allocates a field is responsible for deleting it so these objects clean up the C++ pointers when they are disposed of.

Inheritance Hierarchy

System.Object
Rhino.Render.Fields.Field

Namespace: Rhino.Render.Fields

Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

public abstract class Field

The Field type exposes the following members.

Constructors

Name

Description

---

Protected Method

Field(RenderContent, IntPtr)

Initializes a new instance of the Field class

---

Protected Method

Field(RenderContent, String)

Initializes a new instance of the Field class

---

Protected Method

Field(RenderContent, String, String, Object, Boolean)

Obsolete.

Initializes a new instance of the Field class

---

Protected Method

Field(RenderContent, String, String, Object, Boolean, Boolean)

Initializes a new instance of the Field class

---

Protected Method

Field(RenderContent, String, String, Object, Boolean, Boolean, Int32)

Initializes a new instance of the Field class

---

Properties

Name

Description

---

Public Property

IsHiddenInAutoUI

When fields are used by the automatic UI, they can be hidden from it by calling this method.

---

Public Property

Name

Field name value string passed to the constructor.

---

Public Property

Tag

Gets or sets an object that contains data to associate with the field.

---

Public Property

TextureAmountMax

Set Max value for Texture amount

---

Public Property

TextureAmountMin

Set Min value for Texture amount

---

Public Property

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 Property

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.

---

Methods

Name

Description

---

Protected Method

CreateCppPointer

---

Public Method

Equals

Determines whether the specified object is equal to the current object.

(Inherited from Object.)

---

Protected Method

Finalize

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

(Inherited from Object.)

---

Public Method

GetHashCode

Serves as the default hash function.

(Inherited from Object.)

---

Public Method

GetType

Gets the Type of the current instance.

(Inherited from Object.)

---

Public Method

GetValue.T.

Parametrized version of GetValue calling appropriate ValueAs* methods.

---

Protected Method

MemberwiseClone

Creates a shallow copy of the current Object.

(Inherited from Object.)

---

Public Method

ToString

Returns a string that represents the current object.

(Inherited from Object.)

---

Protected Method

ValueAsBool

Return field value as a bool.

---

Protected Method

ValueAsByteArray

Return field as a byte array.

---

Protected Method

ValueAsColor4f

Return field as a Rhino.Display.Color4f color value.

---

Protected Method

ValueAsDateTime

Return field as a DateTime value.

---

Protected Method

ValueAsDouble

Return field value as a double precision number.

---

Protected Method

ValueAsFloat

Return field value as floating point number.

---

Protected Method

ValueAsGuid

Return field value as Guid.

---

Protected Method

ValueAsInt

Return field value as integer.

---

Public Method

ValueAsObject

---

Protected Method

ValueAsPoint2d

Return field as a Rhino.Geometry.Point2d color value.

---

Protected Method

ValueAsPoint3d

Return field as a Rhino.Geometry.Point3d color value.

---

Protected Method

ValueAsPoint4d

Return field as a Rhino.Geometry.Point4d color value.

---

Protected Method

ValueAsString

Get field value as a string.

---

Protected Method

ValueAsTransform

Return field as a Rhino.Geometry.Transform color value.

---

Protected Method

ValueAsVector2d

Return field as a Rhino.Geometry.Vector2d color value.

---

Protected Method

ValueAsVector3d

Return field as a Rhino.Geometry.Vector3d color value.

---

Inheritance Hierarchy

System.Object
Rhino.Render.Fields.Field
Rhino.Render.Fields.BoolField
Rhino.Render.Fields.ByteArrayField
Rhino.Render.Fields.Color4fField
Rhino.Render.Fields.DateTimeField
Rhino.Render.Fields.DoubleField
Rhino.Render.Fields.FloatField
Rhino.Render.Fields.GuidField
Rhino.Render.Fields.IntField
Rhino.Render.Fields.NullField
Rhino.Render.Fields.Point2dField
Rhino.Render.Fields.Point3dField
Rhino.Render.Fields.Point4dField
Rhino.Render.Fields.StringField
Rhino.Render.Fields.TransformField
Rhino.Render.Fields.Vector2dField
Rhino.Render.Fields.Vector3dField