Texture Class |
Inheritance HierarchyNamespace: Rhino.DocObjects
Assembly: RhinoCommon (in RhinoCommon.dll)
SyntaxThe Texture type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Texture |
Initializes a new texture.
|
 | Texture(SerializationInfo, StreamingContext) |
Protected constructor for internal use.
|
Properties| Name | Description | |
|---|---|---|
 | 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.
(Inherited from CommonObject.) |
| 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.
RemarksAfter 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.
(Inherited from CommonObject.) |
| Id |
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.
(Inherited from CommonObject.) |
| IsValid | Tests an object to see if it is valid. (Inherited from CommonObject.) |
| MappingChannelId | |
| 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
|
| UserData |
List of custom information that is attached to this class.
(Inherited from CommonObject.) |
| UserDictionary |
Dictionary of custom information attached to this class. The dictionary is actually user
data provided as an easy to use sharable set of information.
(Inherited from CommonObject.) |
| UvwTransform |
Transform to be applied to each instance of this texture
if ApplyUvw is true
|
| 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| Name | Description | |
|---|---|---|
| ConstructConstObject |
Assigns a parent object and a sub-object index to this.
(Inherited from CommonObject.) |
| Dispose |
Actively reclaims unmanaged resources that this instance uses.
(Inherited from CommonObject.) |
| Dispose(Boolean) |
For derived class implementers.
(Inherited from CommonObject.)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.
(Inherited from CommonObject.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize |
Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().
(Inherited from CommonObject.) |
| GetAlphaBlendValues |
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) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetObjectData |
Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.
(Inherited from CommonObject.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IsValidWithLog |
Determines if an object is valid. Also provides a report on errors if this
object happens not to be valid.
(Inherited from CommonObject.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| NonConstOperation |
For derived classes implementers.
(Inherited from CommonObject.)Defines the necessary implementation to free the instance from being constant. |
| OnSwitchToNonConst |
Is called when a non-constant operation first occurs.
(Inherited from CommonObject.) |
| SetAlphaBlendValues |
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) |
| SetRGBBlendValues |
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 |
Create a JSON string representation of this object
(Inherited from CommonObject.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also