Texture

Texture class

Represents a texture that is mapped on objects.

Inheritence: Rhino.Runtime.CommonObjectTexture
Derived Classes:

Namespace: Rhino.DocObjects
Texture: references

Constructors (4)

CommonObject()

Allows construction from inheriting classes.

CommonObject(SerializationInfo info, StreamingContext context)

Protected constructor for internal use.

Texture()

Initializes a new texture.

Texture(SerializationInfo info, StreamingContext context)

Protected constructor for internal use.

Properties (28)

ApplyUvwTransform

If True then the UVW transform is applied to the texture otherwise the UVW transform is ignored.

Disposed

Indicates if this object has been disposed or the document it originally belonged to has been disposed.

Enabled

If the texture is enabled then it will be visible in the rendered display otherwise it will not.

FileName

Gets or sets a file name that is used by this texture.
NOTE: We are moving away from string-based FileName, and suggest the usage of the new FileReference class.
Also, this filename may well not be a path that makes sense on a user's computer because it was a path initially set on a different user's computer. If you want to get a workable path for this user, use the BitmapTable.Find function using this property.

FileReference

Gets or sets a copy of the file reference that is used by this texture. After the get or the set method complete, you own the copy you received or passed in, and can Dispose() of it.

HasUserData

Gets True if this class has any custom information attached to it through UserData.

Gets the globally unique identifier of this texture.

IsDocumentControlled

If True this object may not be modified. Any properties or functions that attempt to modify this object when it is set to "IsReadOnly" will throw a NotSupportedException.

IsValid

Tests an object to see if it is valid.

MagFilter

The MagFilter setting controls how the color of the image pixel is calculated when the image pixel corresponds to a fraction of a texture bitmap pixel.

MappingChannelId

MinFilter

The MinFilter setting controls how the color of the image pixel is calculated when the image pixel corresponds to multiple texture bitmap pixels.

Offset

Helper for access to the offset value encoded in UvwTransform

PerformCorruptionTesting

Used to test ON_Object* pointers to see if they are a brep or mesh that is corrupt enough to crash Rhino.

ProjectionMode

How texture is projected onto geometry

Repeat

Helper for access to the repeat value encoded in UvwTransform

Rotation

Helper for access to the rotation value encoded in UvwTransform

TextureCombineMode

Determines how this texture is combined with others in a material's texture list.

TextureType

Controls how the pixels in the bitmap are interpreted

TreatAsLinear

If false, the texture color values should be correctly by the linear workflow pre-process gamma value (in the document) if linear workflow is on. Otherwise, if the values is true, the values should be used raw from the texture.

UserData

List of custom information that is attached to this class.

UserDictionary

Dictionary of custom information attached to this class. The dictionary is actually user data provided as an easy to use shareable set of information.

UvwTransform

Transform to be applied to each instance of this texture if ApplyUvw is true

WcsBoxProjected

Is True if this texture uses world coordinate system (WCS) box projection for texture mapping. Notice: If this texture is used by an object that has an object coordinate system (OCS) frame defined on a mapping channel then that OCS frame is used instead of the WCS.

WcsProjected

Is True if this texture uses world coordinate system (WCS) projection for texture mapping. Notice: If this texture is used by an object that has an object coordinate system (OCS) frame defined on a mapping channel then that OCS frame is used instead of the WCS.

WrapU

Texture wrapping mode in the U direction

WrapV

Texture wrapping mode in the V direction

WrapW

Texture wrapping mode in the W direction

Methods (15)

ConstructConstObject(Object parentObject,Int32 subobjectIndex)

Assigns a parent object and a sub-object index to this.

Dispose()

Actively reclaims unmanaged resources that this instance uses.

Dispose(Boolean disposing)

For derived class implementers.
This method is called with argument True when class user calls Dispose(), while with argument False when the Garbage Collector invokes the finalizer, or Finalize() method.
You must reclaim all used unmanaged resources in both cases, and can use this chance to call Dispose on disposable fields if the argument is true.
Also, you must call the base virtual method within your overriding method.

EnsurePrivateCopy()

If you want to keep a copy of this class around by holding onto it in a variable after a command completes, call EnsurePrivateCopy to make sure that this class is not tied to the document. You can call this function as many times as you want.

FromBase64String(Int32 archive3dm,Int32 opennurbs,String base64Data)

Create a CommonObject instance from a Base64 encoded string. This is typically the values used when passing common objects around as JSON data

FromJSON(Dictionary<string, string> jsonDictionary)

Create a CommonObject instance from a JSON dictionary

FromJSON(String json)

Create a CommonObject instance from a JSON string

GetAlphaBlendValues(Double constant,Double a0,Double a1,Double a2,Double a3)

If the TextureCombineMode is Blend, then the blending function for alpha is determined by
new alpha = constant + a0*(current alpha) + a1*(texture alpha) + a2*min(current alpha,texture alpha) + a3*max(current alpha,texture alpha)

GetObjectData(SerializationInfo info,StreamingContext context)

Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.

IsValidWithLog(String log)

Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.

NonConstOperation()

For derived classes implementers.
Defines the necessary implementation to free the instance from being constant.

OnSwitchToNonConst()

Is called when a non-constant operation first occurs.

SetAlphaBlendValues(Double constant,Double a0,Double a1,Double a2,Double a3)

SetRGBBlendValues(Color color,Double a0,Double a1,Double a2,Double a3)

If the TextureCombineMode is Blend, then the blending function for RGB is determined by
new rgb = colorcolor + a0[0]*(current RGB) + a1[1]*(texture RGB) + a2[2]*min(current RGB,texture RGB) + a3[3]*max(current RGB,texture RGB)

ToJSON(SerializationOptions options)

Create a JSON string representation of this object

Nothing found