FieldDictionary
Dictionary containing RenderContent data fields. Add fields to this dictionary in your derived RenderContent classes constructor. Get field values using the TryGet[data type]() methods and set them using the Set() method.
Inheritance Hierarchy
System.Object
Rhino.Render.Fields.FieldDictionary
Namespace: Rhino.Render.Fields
Assembly: RhinoCommon (in RhinoCommon.dll)
Syntax
public sealed class FieldDictionary : IEnumerableThe FieldDictionary type exposes the following members.
Methods
Name
Description
Public Method
Add(String, Color4f)
Add a new Color4fField to the dictionary. This will be a data only field and not show up in the content browsers.
Public Method
Add(String, Point2d)
Add a new Point2dField to the dictionary. This will be a data only field and not show up in the content browsers.
Public Method
Add(String, Point3d)
Add a new Point3dField to the dictionary. This will be a data only field and not show up in the content browsers.
Public Method
Add(String, Point4d)
Add a new Point4dField to the dictionary. This will be a data only field and not show up in the content browsers.
Public Method
Add(String, Transform)
Add a new TransformField to the dictionary. This will be a data only field and not show up in the content browsers.
Public Method
Add(String, Vector2d)
Add a new Vector2dField to the dictionary. This will be a data only field and not show up in the content browsers.
Public Method
Add(String, Vector3d)
Add a new Vector3dField to the dictionary. This will be a data only field and not show up in the content browsers.
Public Method
Add(String, Boolean)
Add a new BoolField to the dictionary. This will be a data only field and not show up in the content browsers.
Public Method
Add(String, .Byte.)
AddField a new ByteArrayField to the dictionary. This will be a data only field and not show up in the content browsers.
Public Method
Add(String, DateTime)
Add a new DateTimeField to the dictionary. This will be a data only field and not show up in the content browsers.
Public Method
Add(String, Double)
AddField a new DoubleField to the dictionary. This will be a data only field and not show up in the content browsers.
Public Method
Add(String, Color)
Add a new Color4fField to the dictionary. This will be a data only field and not show up in the content browsers.
Public Method
Add(String, Guid)
Add a new GuidField to the dictionary. This will be a data only field and not show up in the content browsers.
Public Method
Add(String, Int32)
Add a new IntField to the dictionary. This will be a data only field and not show up in the content browsers.
Public Method
Add(String, Single)
Add a new FloatField to the dictionary. This will be a data only field and not show up in the content browsers.
Public Method
Add(String, String)
Add a new StringField to the dictionary. This will be a data only field and not show up in the content browsers.
Public Method
Add(String, Color4f, String)
Add a new Color4fField to the dictionary.
Public Method
Add(String, Point2d, String)
Add a new Point2dField to the dictionary.
Public Method
Add(String, Point3d, String)
Add a new Point3dField to the dictionary.
Public Method
Add(String, Point4d, String)
Add a new Point4dField to the dictionary.
Public Method
Add(String, Transform, String)
Add a new TransformField to the dictionary.
Public Method
Add(String, Vector2d, String)
Add a new Vector2dField to the dictionary.
Public Method
Add(String, Vector3d, String)
Add a new Vector3dField to the dictionary.
Public Method
Add(String, Boolean, String)
Add a new BoolField to the dictionary.
Public Method
Add(String, DateTime, String)
Add a new DateTimeField to the dictionary.
Public Method
Add(String, Double, String)
Add a new DoubleField to the dictionary.
Public Method
Add(String, Color, String)
Add a new Color4fField to the dictionary.
Public Method
Add(String, Guid, String)
Add a new GuidField to the dictionary.
Public Method
Add(String, Int32, String)
Add a new IntField to the dictionary.
Public Method
Add(String, Single, String)
AddField a new FloatField to the dictionary.
Public Method
Add(String, String, Int32)
Add a new NullField to the dictionary.
Public Method
Add(String, String, String)
Add a new StringField to the dictionary.
Public Method
Add(String, Color4f, String, Int32)
Add a new Color4fField to the dictionary.
Public Method
Add(String, Point2d, String, Int32)
Add a new Point2dField to the dictionary.
Public Method
Add(String, Point3d, String, Int32)
Add a new Point3dField to the dictionary.
Public Method
Add(String, Point4d, String, Int32)
Add a new Point4dField to the dictionary.
Public Method
Add(String, Transform, String, Int32)
Add a new TransformField to the dictionary.
Public Method
Add(String, Vector2d, String, Int32)
Add a new Vector2dField to the dictionary.
Public Method
Add(String, Vector3d, String, Int32)
Add a new Vector3dField to the dictionary.
Public Method
Add(String, Boolean, String, Int32)
Add a new BoolField to the dictionary.
Public Method
Add(String, DateTime, String, Int32)
Add a new DateTimeField to the dictionary.
Public Method
Add(String, Double, String, Int32)
Add a new DoubleField to the dictionary.
Public Method
Add(String, Guid, String, Int32)
Add a new GuidField to the dictionary.
Public Method
Add(String, Int32, String, Int32)
Add a new IntField to the dictionary.
Public Method
Add(String, Single, String, Int32)
AddField a new FloatField to the dictionary.
Public Method
Add(String, String, String, Int32)
Add a new StringField to the dictionary.
Public Method
AddFilename
Add a new StringField to the dictionary which will reference a filename. A file watcher will automatically be attached to the referenced file, and the content will be considered changed when the file is changed on disk.
Public Method
AddTextured(String, String)
Add a new NullField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, Color4f, String)
Obsolete.
Public Method
AddTextured(String, Point2d, String)
Add a new Point2dField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, Point3d, String)
Add a new Point3dField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, Point4d, String)
Add a new Point4dField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, Transform, String)
Add a new TransformField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, Vector2d, String)
Add a new Vector2dField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, Vector3d, String)
Add a new Vector3dField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, Boolean, String)
Add a new BoolField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, DateTime, String)
Add a new DateTimeField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, Double, String)
Add a new DoubleField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, Color, String)
Add a new Color4fField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, Guid, String)
Add a new GuidField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, Int32, String)
Add a new IntField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, Single, String)
Add a new FloatField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, String, Boolean)
Add a new NullField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, String, String)
Add a new StringField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, Color4f, String, Boolean)
Add a new Color4fField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, Point2d, String, Boolean)
Add a new Point2dField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, Point3d, String, Boolean)
Add a new Point3dField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, Point4d, String, Boolean)
Add a new Point4dField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, Transform, String, Boolean)
Add a new TransformField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, Vector2d, String, Boolean)
Add a new Vector2dField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, Vector3d, String, Boolean)
Add a new Vector3dField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, Boolean, String, Boolean)
Add a new BoolField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, DateTime, String, Boolean)
Add a new DateTimeField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, Double, String, Boolean)
Add a new DoubleField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, Color, String, Boolean)
Add a new Color4fField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, Guid, String, Boolean)
Add a new GuidField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, Int32, String, Boolean)
Add a new IntField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, Single, String, Boolean)
Add a new FloatField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, String, Boolean, Int32)
Add a new NullField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, String, String, Boolean)
Add a new StringField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, Color4f, String, Boolean, Int32)
Add a new Color4fField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, Point2d, String, Boolean, Int32)
Add a new Point2dField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, Point3d, String, Boolean, Int32)
Add a new Point3dField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, Point4d, String, Boolean, Int32)
Add a new Point4dField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, Transform, String, Boolean, Int32)
Add a new TransformField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, Vector2d, String, Boolean, Int32)
Add a new Vector2dField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, Vector3d, String, Boolean, Int32)
Add a new Vector3dField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, Boolean, String, Boolean, Int32)
Add a new BoolField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, DateTime, String, Boolean, Int32)
Add a new DateTimeField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, Double, String, Boolean, Int32)
Add a new DoubleField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, Guid, String, Boolean, Int32)
Add a new GuidField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, Int32, String, Boolean, Int32)
Add a new IntField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, Single, String, Boolean, Int32)
Add a new FloatField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
AddTextured(String, String, String, Boolean, Int32)
Add a new StringField to the dictionary. This overload will cause the field to be tagged as “textured” so that the texturing UI will appear in automatic UIs.
Public Method
ContainsField
Call this method to determine if a this FieldsList contains a field with the specified field name.
Public Method
Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public Method
GetEnumerator
Public Method
GetField
Call this method to get the field with the specified name.
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
RemoveField
Public Method
Set(String, Color4f)
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
Public Method
Set(String, Point2d)
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
Public Method
Set(String, Point3d)
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
Public Method
Set(String, Point4d)
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
Public Method
Set(String, Transform)
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
Public Method
Set(String, Vector2d)
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
Public Method
Set(String, Vector3d)
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
Public Method
Set(String, Boolean)
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
Public Method
Set(String, .Byte.)
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
Public Method
Set(String, DateTime)
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
Public Method
Set(String, Double)
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
Public Method
Set(String, Color)
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
Public Method
Set(String, Guid)
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
Public Method
Set(String, Int32)
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
Public Method
Set(String, Single)
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
Public Method
Set(String, String)
Set the field value and send the appropriate change notification to the render SDK. Will throw a InvalidOperationException exception if the key name is not valid.
Public Method
ToString
Returns a string that represents the current object.
(Inherited from Object.)
Public Method
TryGetValue(String, Color4f.)
Find a field with the specified key and get its value if found.
Public Method
TryGetValue(String, Point2d.)
Find a field with the specified key and get its value if found.
Public Method
TryGetValue(String, Point3d.)
Find a field with the specified key and get its value if found.
Public Method
TryGetValue(String, Point4d.)
Find a field with the specified key and get its value if found.
Public Method
TryGetValue(String, Transform.)
Find a field with the specified key and get its value if found.
Public Method
TryGetValue(String, Vector2d.)
Find a field with the specified key and get its value if found.
Public Method
TryGetValue(String, Vector3d.)
Find a field with the specified key and get its value if found.
Public Method
TryGetValue(String, Boolean.)
Find a field with the specified key and get its value if found.
Public Method
TryGetValue(String, .Byte..)
Find a field with the specified key and get its value if found.
Public Method
TryGetValue(String, DateTime.)
Find a field with the specified key and get its value if found.
Public Method
TryGetValue(String, Double.)
Find a field with the specified key and get its value if found.
Public Method
TryGetValue(String, Color.)
Find a field with the specified key and get its value if found.
Public Method
TryGetValue(String, Guid.)
Find a field with the specified key and get its value if found.
Public Method
TryGetValue(String, Int32.)
Find a field with the specified key and get its value if found.
Public Method
TryGetValue(String, Single.)
Find a field with the specified key and get its value if found.
Public Method
TryGetValue(String, String.)
Find a field with the specified key and get its value if found.
Public Method
TryGetValue.T.(String, T.)
Parametrized version of TryGetValue.
Examples
[System.Runtime.InteropServices.Guid(“ABE4059B-9BD7-451C-91B2-67C2F188860A”)] public class CustomMaterial : RenderMaterial { public override string TypeName { get { return “CSharp Custom Material”; } } public override string TypeDescription { get { return “My first custom .NET material”; } } public CustomMaterial() { Fields.AddField(“bool”, false, “Yes/No”); Fields.AddField(“color”, Rhino.Display.Color4f.White, “Color”); } }