T_Rhino_Render_TextureMapping - mcneel/rhinocommon-api-docs GitHub Wiki

TextureMapping Class

Represents a texture mapping.

Inheritance Hierarchy

System.Object
  Rhino.Runtime.CommonObject
    Rhino.Render.TextureMapping
Namespace: Rhino.Render
Assembly: RhinoCommon (in RhinoCommon.dll) Version: Rhino 6.0

Syntax

C#

public class TextureMapping : CommonObject

VB

Public Class TextureMapping
	Inherits CommonObject

The TextureMapping type exposes the following members.

Properties

 

Name Description
Public property HasUserData Gets true if this class has any custom information attached to it through UserData. (Inherited from CommonObject.)
Public property Id The unique Id for this texture mapping object.
Public property 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.)
Public property IsValid Tests an object to see if it is valid. (Inherited from CommonObject.)
Public property MappingType Texture mapping type associated with this Mapping object.
Public property NormalTransform For primitive based mappings, these transformations are used to map the world coordinate (x,y,z) point P and surface normal N before it is projected to the normalized mapping primitive. The surface normal transformation, m_Nxyz, is always calculated from m_Pxyz. It is a runtime setting that is not saved in 3dm files. If m_type is srfp_mapping, then m_Pxyz and m_Nxyz are ignored.
Public property PrimativeTransform For primitive based mappings, these transformations are used to map the world coordinate (x,y,z) point P and surface normal N before it is projected to the normalized mapping primitive. The surface normal transformation, m_Nxyz, is always calculated from m_Pxyz. It is a runtime setting that is not saved in 3dm files. If m_type is srfp_mapping, then m_Pxyz and m_Nxyz are ignored.
Public property UserData List of custom information that is attached to this class. (Inherited from CommonObject.)
Public property 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.)
Public property UvwTransform Transform applied to mapping coordinate (u,v,w) to convert it into a texture coordinate.
  Back to Top

Methods

 

Name Description
Protected method ConstructConstObject Assigns a parent object and a subobject index to this. (Inherited from CommonObject.)
Public methodStatic member CreateBoxMapping Create a box projection texture mapping.
Public methodStatic member CreateCylinderMapping Create a cylindrical projection texture mapping.
Public methodStatic member CreatePlaneMapping Create a planar projection texture mapping
Public methodStatic member CreateSphereMapping Create a spherical projection texture mapping.
Public method Dispose() Actively reclaims unmanaged resources that this instance uses. (Inherited from CommonObject.)
Protected method Dispose(Boolean) 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.

(Inherited from CommonObject.)

Public 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.)
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Passively reclaims unmanaged resources when the class user did not explicitly call Dispose(). (Inherited from CommonObject.)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetObjectData Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object. (Inherited from CommonObject.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IsValidWithLog Determines if an object is valid. Also provides a report on errors if this object happens not to be valid. (Inherited from CommonObject.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method NonConstOperation For derived classes implementers. Defines the necessary implementation to free the instance from being const.

(Inherited from CommonObject.)

Protected method OnSwitchToNonConst Is called when a non-const operation first occurs. (Inherited from CommonObject.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method TryGetMappingBox Get a box projection from the texture mapping.
Public method TryGetMappingCylinder Get a cylindrical projection parameters from this texture mapping.
Public method TryGetMappingPlane Get plane mapping parameters from this texture mapping.
Public method TryGetMappingSphere Get a spherical projection parameters from this texture mapping.
  Back to Top

Version Information

Supported in: 5D58w

See Also

Reference

Rhino.Render Namespace

⚠️ **GitHub.com Fallback** ⚠️