StringField

StringField class

String field value class

Inheritence: Rhino.Render.Fields.FieldStringField
Derived Classes:

Namespace: Rhino.Render.Fields
StringField: references

Constructors (6)

Field(RenderContent renderContent, IntPtr pointer)

Field(RenderContent renderContent, string name, string prompt, object initialValue, bool isTextured, bool treatAsLinear, int sectionId)

Field(RenderContent renderContent, string name, string prompt, object initialValue, bool isTextured, bool treatAsLinear)

Field(RenderContent renderContent, string name, string prompt, object initialValue, bool isTextured)

Field(RenderContent renderContent, string name)

StringField()

Initializes a new instance of the StringField class

Properties (9)

IsHiddenInAutoUI

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

Key

Field name value string passed to the constructor

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.

Value

Gets or sets the field value

Methods (19)

CreateCppPointer(RenderContent content,String key,String prompt,Object initialValue,Boolean isTextured,Boolean treatAsLinear)

GetValue()

Parametrized version of GetValue calling appropriate ValueAs* methods.

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.

Nothing found