Field 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

SystemObject
Rhino.Render.FieldsField
More...

Namespace: Rhino.Render.Fields
Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

Copy

public abstract class Field

Public MustInherit Class Field

The Field type exposes the following members.

Constructors

	Name	Description
	Field(RenderContent, IntPtr)	Initializes a new instance of the Field class
	Field(RenderContent, String)	Initializes a new instance of the Field class
	Field(RenderContent, String, String, Object, Boolean)	Obsolete. Initializes a new instance of the Field class
	Field(RenderContent, String, String, Object, Boolean, Boolean)	Initializes a new instance of the Field class
	Field(RenderContent, String, String, Object, Boolean, Boolean, Int32)	Initializes a new instance of the Field class

Top

Properties

	Name	Description
	IsHiddenInAutoUI	When fields are used by the automatic UI, they can be hidden from it by calling this method.
	Name	Field name value string passed to the constructor.
	Tag	Gets or sets an object that contains data to associate with the field.
	TextureAmountMax	Set Max value for Texture amount
	TextureAmountMin	Set Min value for Texture amount
	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.
	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.

Top

Methods

	Name	Description
	CreateCppPointer
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValueT	Parametrized version of GetValue calling appropriate ValueAs* methods.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	ValueAsBool	Return field value as a bool.
	ValueAsByteArray	Return field as a byte array.
	ValueAsColor4f	Return field as a Rhino.Display.Color4f color value.
	ValueAsDateTime	Return field as a DateTime value.
	ValueAsDouble	Return field value as a double precision number.
	ValueAsFloat	Return field value as floating point number.
	ValueAsGuid	Return field value as Guid.
	ValueAsInt	Return field value as integer.
	ValueAsObject
	ValueAsPoint2d	Return field as a Rhino.Geometry.Point2d color value.
	ValueAsPoint3d	Return field as a Rhino.Geometry.Point3d color value.
	ValueAsPoint4d	Return field as a Rhino.Geometry.Point4d color value.
	ValueAsString	Get field value as a string.
	ValueAsTransform	Return field as a Rhino.Geometry.Transform color value.
	ValueAsVector2d	Return field as a Rhino.Geometry.Vector2d color value.
	ValueAsVector3d	Return field as a Rhino.Geometry.Vector3d color value.

Top

Reference

Rhino.Render.Fields Namespace

Inheritance Hierarchy