class TangentCalculator
TangentCalculator calculates tangent vectors for geometry data objects. One corner field of texture coordinates must exist, as well as normals. The tangents are placed into two corner fields called "Tangents" and "Bitangents". If any of these fields already exists, it is replaced by the new field.
Properties
| Property | Description |
|---|
| InvertV | Inverts the V component of the texcoords used for tangent calculation. This essentially switches between right- and lefthanded, i.e. TangentCalculatorType = OrthonormalRightHanded and InvertV = true generates equivalent tangents to TangentCalculatorType = OrthonormalLeftHanded. |
| Name | The name of the TangentCalculator object. (Inherited from Object) |
| TangentCalculatorType | Sets/Gets the tangent calculator type, types listed in TangentSpaceMethod. |
| TexCoordsSetId | The TexCoords field id to use for the tangent calculation. If set to -1, all texture coordinates will get corresponding tangent fields. |
Methods
| Method | Description |
|---|
| AddObserver | Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object) |
| CalculateTangents | Calculates the tangents of a geometry data object. |
| CalculateTangentsForNodeHierarchy | Calculates the tangents of a tree of scene nodes (only the geometry nodes of course). |
| GetClass | Get the name of the TangentCalculator class. (Inherited from Object) |
| IsA | Returns true if TangentCalculator is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| IsNull | Returns true if the TangentCalculator object is invalid. (Inherited from Object) |
| IsSameObjectAs | Returns true if the TangentCalculator object is valid. (Inherited from Object) |
| NonNull | Returns true if the TangentCalculator object is valid. (Inherited from Object) |
| PrintInfo | Prints the content/info of the TangentCalculator object to the log. (Inherited from Object) |
| RemoveObserver | Removes a previously added observer object. (Inherited from Object) |
Static methods
| Method | Description |
|---|
| IsClassA | Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| SafeCast | SafeCast makes sure the input object is of a class that can be cast into spTangentCalculator, and if this is the case, returns the object cast into spTangentCalculator. (Inherited from Object) |
Properties details
InvertV
Inverts the V component of the texcoords used for tangent calculation. This essentially switches between right- and lefthanded, i.e. TangentCalculatorType = OrthonormalRightHanded and InvertV = true generates equivalent tangents to TangentCalculatorType = OrthonormalLeftHanded.
Syntax
SetInvertV parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired value of InvertV. |
GetInvertV return value
Type: bool
Default: false
Syntax
SetInvertV parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired value of InvertV. |
GetInvertV return value
Type: bool
Default: false
Syntax
SetInvertV parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The desired value of InvertV. |
GetInvertV return value
Type: bool
Default: false
Name
The name of the TangentCalculator object. (Inherited from Object)
Syntax
SetName parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | New name of the object. |
GetName return value
Type: spString
Syntax
SetName parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | New name of the object. |
GetName return value
Type: string
Syntax
SetName parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | New name of the object. |
GetName return value
Type: str
TangentCalculatorType
Sets/Gets the tangent calculator type, types listed in TangentSpaceMethod.
Syntax
SetTangentCalculatorType parameters
GetTangentCalculatorType return value
Type: ETangentSpaceMethod
Default: OrthonormalRightHanded
| Key | Value | Comment |
|---|
| OrthonormalRightHanded | 0 | Standard method, creates an orthonormal tangent space (right-handed) |
| Autodesk3dsMax | 1 | 3dsMax compatible method, creates tangent space that is compatible with the 3dsMax renderer |
| OrthonormalLeftHanded | 2 | Creates an orthonormal tangent space (left-handed, D3D compatible) |
| MikkTSpace | 3 | Creates a tangent space using the MikkTSpace tangent space generation algorithm. |
Syntax
SetTangentCalculatorType parameters
GetTangentCalculatorType return value
Type: ETangentSpaceMethod
Default: OrthonormalRightHanded
| Key | Value | Comment |
|---|
| OrthonormalRightHanded | 0 | Standard method, creates an orthonormal tangent space (right-handed) |
| Autodesk3dsMax | 1 | 3dsMax compatible method, creates tangent space that is compatible with the 3dsMax renderer |
| OrthonormalLeftHanded | 2 | Creates an orthonormal tangent space (left-handed, D3D compatible) |
| MikkTSpace | 3 | Creates a tangent space using the MikkTSpace tangent space generation algorithm. |
Syntax
SetTangentCalculatorType parameters
GetTangentCalculatorType return value
Type: ETangentSpaceMethod
Default: OrthonormalRightHanded
| Key | Value | Comment |
|---|
| ETangentSpaceMethod_OrthonormalRightHanded | 0 | Standard method, creates an orthonormal tangent space (right-handed) |
| ETangentSpaceMethod_Autodesk3dsMax | 1 | 3dsMax compatible method, creates tangent space that is compatible with the 3dsMax renderer |
| ETangentSpaceMethod_OrthonormalLeftHanded | 2 | Creates an orthonormal tangent space (left-handed, D3D compatible) |
| ETangentSpaceMethod_MikkTSpace | 3 | Creates a tangent space using the MikkTSpace tangent space generation algorithm. |
TexCoordsSetId
The TexCoords field id to use for the tangent calculation. If set to -1, all texture coordinates will get corresponding tangent fields.
Syntax
SetTexCoordsSetId parameters
| Type | Name | Min | Max | Description |
|---|
rid | value | | | The desired texcoordset id. |
GetTexCoordsSetId return value
Type: rid
Default: 0
Syntax
SetTexCoordsSetId parameters
| Type | Name | Min | Max | Description |
|---|
int | value | | | The desired texcoordset id. |
GetTexCoordsSetId return value
Type: int
Default: 0
Syntax
SetTexCoordsSetId parameters
| Name | Type | Min | Max | Description |
|---|
| value | int | | | The desired texcoordset id. |
GetTexCoordsSetId return value
Type: int
Default: 0
Methods details
AddObserver
Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Observer | observer | | | Observer is the object that will receive events. |
Return value
Type: rid
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Observer | observer | | | Observer is the object that will receive events. |
Return value
Type: int
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| observer | Observer | | | Observer is the object that will receive events. |
Return value
Type: int
CalculateTangents
Calculates the tangents of a geometry data object.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| GeometryData | geom | | | The geometry object receives new fields, as described in the class description. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| GeometryData | geom | | | The geometry object receives new fields, as described in the class description. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| geom | GeometryData | | | The geometry object receives new fields, as described in the class description. |
CalculateTangentsForNodeHierarchy
Calculates the tangents of a tree of scene nodes (only the geometry nodes of course).
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
SceneNode | node | | | Is the scene node that will have itselfs and its childrens tangents calculated. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
SceneNode | node | | | Is the scene node that will have itselfs and its childrens tangents calculated. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| node | SceneNode | | | Is the scene node that will have itselfs and its childrens tangents calculated. |
GetClass
Get the name of the TangentCalculator class. (Inherited from Object)
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: spString
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: string
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: str
IsA
Returns true if TangentCalculator is a or is a descendant of the class named as the type parameter. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | type | | | Name of the class to check if TangentCalculator is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | type | | | Name of the class to check if TangentCalculator is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| type | str | | | Name of the class to check if TangentCalculator is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the TangentCalculator object is invalid. (Inherited from Object)
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
IsSameObjectAs
Returns true if the TangentCalculator object is valid. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to compare with. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to compare with. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| object | Object | | | Object to compare with. |
Return value
Type: bool
NonNull
Returns true if the TangentCalculator object is valid. (Inherited from Object)
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
PrintInfo
Prints the content/info of the TangentCalculator object to the log. (Inherited from Object)
Syntax
Parameters
PrintInfo takes no parameters.
Syntax
Parameters
PrintInfo takes no parameters.
Syntax
Parameters
PrintInfo takes no parameters.
RemoveObserver
Removes a previously added observer object. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | observerId | | | ObserverId is the id returned by AddObserver when the observer was added. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | observerId | | | ObserverId is the id returned by AddObserver when the observer was added. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| observerId | int | | | ObserverId is the id returned by AddObserver when the observer was added. |
Static methods details
IsClassA
Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | type | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | type | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| type | str | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
SafeCast
SafeCast makes sure the input object is of a class that can be cast into spTangentCalculator, and if this is the case, returns the object cast into spTangentCalculator. (Inherited from Object)
