class NormalCalculationSettings
Settings for the normal recalculation
Properties
| Property | Description |
|---|
| HardEdgeAngle | Set HardEdgeAngle in degrees. If the angle between two triangles are above this value, the normals will not be smooth over the edge between those two triangles. |
| Name | The name of the NormalCalculationSettings object. (Inherited from Object) |
| ReorthogonalizeTangentSpace | If set, the tangentspaces already existing in the scene will be readjusted so that the tangent and binormal are both orthogonal to the normal. Will be needed since most of the time the normals are changed in the reduction process. |
| RepairInvalidNormals | If set, normals that are invalid will be replaced. All others are left intact. Bad normals are those that are either zero length, or simply points away from the surface. |
| ReplaceNormals | If set, it will generate new normals for the Geometry, and if not set, it will keep the normals from the original normal set (or not add normals at all if none were present). Please note that if the original geometry contains normals, the normal repairer will replace invalid normals even if ReplaceNormals is set to false. |
| ReplaceTangents | If set, it will generate new tangents and bitangents for the Geometry, and if not set, it will keep the new tangents and bitangents from the original normal set (or not add tangents and bitangents at all if none were present). |
| ScaleByAngle | If set, the influence of a triangle normal upon the vertex normals is scaled by the angle of the corner at the vertex. |
| ScaleByArea | If set, the influence of a triangle normal upon the vertex normals is scaled by the area of the triangle. |
| SnapNormalsToFlatSurfaces | If set, perfectly flat shaded surfaces will be created, where possible. Normals adjacent to perfectly geometrically flat surfaces will be recalculated to have the same direction as for those of the adjacent flat surface. |
Methods
| Method | Description |
|---|
| AddObserver | Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object) |
| GetBoolParameter | Get a named parameter boolean value. (Inherited from SettingsObject) |
| GetClass | Get the name of the NormalCalculationSettings class. (Inherited from Object) |
| GetDoubleParameter | Get a named parameter floating point value. (Inherited from SettingsObject) |
| GetErrorString | Returns a string describing the error that was found the last time ValidateSettings was performed. (Inherited from SettingsObject) |
| GetIntParameter | Get a named parameter integer value. (Inherited from SettingsObject) |
| GetStringParameter | Get a named parameter string value. (Inherited from SettingsObject) |
| GetUIntParameter | Get a named parameter unsigned integer value. (Inherited from SettingsObject) |
| IsA | Returns true if NormalCalculationSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| IsNull | Returns true if the NormalCalculationSettings object is invalid. (Inherited from Object) |
| IsSameObjectAs | Returns true if the NormalCalculationSettings object is valid. (Inherited from Object) |
| NonNull | Returns true if the NormalCalculationSettings object is valid. (Inherited from Object) |
| PrintInfo | Prints the content/info of the NormalCalculationSettings object to the log. (Inherited from Object) |
| RemoveObserver | Removes a previously added observer object. (Inherited from Object) |
| SetBoolParameter | Set a named parameter boolean value. (Inherited from SettingsObject) |
| SetDoubleParameter | Set a named parameter floating point value. (Inherited from SettingsObject) |
| SetIntParameter | Set a named parameter integer value. (Inherited from SettingsObject) |
| SetStringParameter | Set a named parameter string value. (Inherited from SettingsObject) |
| SetUIntParameter | Set a named parameter unsigned integer value. (Inherited from SettingsObject) |
| SetValidateParameterNames | Set if parameter names should be validated or not. Parameters that previously do not exist will generate and error if validation is enabled and be allowed if validation is disabled. (Inherited from SettingsObject) |
| ToJSON | Get settings as JSON for debugging purposes. (Inherited from SettingsObject) |
| ValidateSettings | Validates the current settings values. (Inherited from SettingsObject) |
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 spNormalCalculationSettings, and if this is the case, returns the object cast into spNormalCalculationSettings. (Inherited from Object) |
Properties details
HardEdgeAngle
Set HardEdgeAngle in degrees. If the angle between two triangles are above this value, the normals will not be smooth over the edge between those two triangles.
Syntax
SetHardEdgeAngle parameters
| Type | Name | Min | Max | Description |
|---|
real | value | 0 | 180 | The value to which HardEdgeAngle is to be set. |
GetHardEdgeAngle return value
Type: real
Default: 75
Syntax
SetHardEdgeAngle parameters
| Type | Name | Min | Max | Description |
|---|
float | value | 0 | 180 | The value to which HardEdgeAngle is to be set. |
GetHardEdgeAngle return value
Type: float
Default: 75
Syntax
SetHardEdgeAngle parameters
| Name | Type | Min | Max | Description |
|---|
| value | float | 0 | 180 | The value to which HardEdgeAngle is to be set. |
GetHardEdgeAngle return value
Type: float
Default: 75
Name
The name of the NormalCalculationSettings 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
ReorthogonalizeTangentSpace
If set, the tangentspaces already existing in the scene will be readjusted so that the tangent and binormal are both orthogonal to the normal. Will be needed since most of the time the normals are changed in the reduction process.
Syntax
SetReorthogonalizeTangentSpace parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value to reorthogonalize tangent space. |
GetReorthogonalizeTangentSpace return value
Type: bool
Default: true
Syntax
SetReorthogonalizeTangentSpace parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired flag value to reorthogonalize tangent space. |
GetReorthogonalizeTangentSpace return value
Type: bool
Default: true
Syntax
SetReorthogonalizeTangentSpace parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The desired flag value to reorthogonalize tangent space. |
GetReorthogonalizeTangentSpace return value
Type: bool
Default: true
RepairInvalidNormals
If set, normals that are invalid will be replaced. All others are left intact. Bad normals are those that are either zero length, or simply points away from the surface.
Syntax
SetRepairInvalidNormals parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The value to which RepairInvalidNormals is to be set. |
GetRepairInvalidNormals return value
Type: bool
Default: false
Syntax
SetRepairInvalidNormals parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The value to which RepairInvalidNormals is to be set. |
GetRepairInvalidNormals return value
Type: bool
Default: false
Syntax
SetRepairInvalidNormals parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The value to which RepairInvalidNormals is to be set. |
GetRepairInvalidNormals return value
Type: bool
Default: false
ReplaceNormals
If set, it will generate new normals for the Geometry, and if not set, it will keep the normals from the original normal set (or not add normals at all if none were present). Please note that if the original geometry contains normals, the normal repairer will replace invalid normals even if ReplaceNormals is set to false.
Syntax
SetReplaceNormals parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The value to which the ReplaceNormals bool is to be set. |
GetReplaceNormals return value
Type: bool
Default: false
Syntax
SetReplaceNormals parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The value to which the ReplaceNormals bool is to be set. |
GetReplaceNormals return value
Type: bool
Default: false
Syntax
SetReplaceNormals parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The value to which the ReplaceNormals bool is to be set. |
GetReplaceNormals return value
Type: bool
Default: false
ReplaceTangents
If set, it will generate new tangents and bitangents for the Geometry, and if not set, it will keep the new tangents and bitangents from the original normal set (or not add tangents and bitangents at all if none were present).
Syntax
SetReplaceTangents parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The value to which the ReplaceTangents bool is to be set. |
GetReplaceTangents return value
Type: bool
Default: false
Syntax
SetReplaceTangents parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The value to which the ReplaceTangents bool is to be set. |
GetReplaceTangents return value
Type: bool
Default: false
Syntax
SetReplaceTangents parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The value to which the ReplaceTangents bool is to be set. |
GetReplaceTangents return value
Type: bool
Default: false
ScaleByAngle
If set, the influence of a triangle normal upon the vertex normals is scaled by the angle of the corner at the vertex.
Syntax
SetScaleByAngle parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The value to which the ScaleByAngle bool is to be set. |
GetScaleByAngle return value
Type: bool
Default: true
Syntax
SetScaleByAngle parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The value to which the ScaleByAngle bool is to be set. |
GetScaleByAngle return value
Type: bool
Default: true
Syntax
SetScaleByAngle parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The value to which the ScaleByAngle bool is to be set. |
GetScaleByAngle return value
Type: bool
Default: true
ScaleByArea
If set, the influence of a triangle normal upon the vertex normals is scaled by the area of the triangle.
Syntax
SetScaleByArea parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The value to which the ScaleByArea bool is to be set. |
GetScaleByArea return value
Type: bool
Default: true
Syntax
SetScaleByArea parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The value to which the ScaleByArea bool is to be set. |
GetScaleByArea return value
Type: bool
Default: true
Syntax
SetScaleByArea parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The value to which the ScaleByArea bool is to be set. |
GetScaleByArea return value
Type: bool
Default: true
SnapNormalsToFlatSurfaces
If set, perfectly flat shaded surfaces will be created, where possible. Normals adjacent to perfectly geometrically flat surfaces will be recalculated to have the same direction as for those of the adjacent flat surface.
Syntax
SetSnapNormalsToFlatSurfaces parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | To use for SnapNormalsToFlatSurfaces. |
GetSnapNormalsToFlatSurfaces return value
Type: bool
Default: false
Syntax
SetSnapNormalsToFlatSurfaces parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | To use for SnapNormalsToFlatSurfaces. |
GetSnapNormalsToFlatSurfaces return value
Type: bool
Default: false
Syntax
SetSnapNormalsToFlatSurfaces parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | To use for SnapNormalsToFlatSurfaces. |
GetSnapNormalsToFlatSurfaces return value
Type: bool
Default: false
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
GetBoolParameter
Get a named parameter boolean value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
Return value
Type: bool
GetClass
Get the name of the NormalCalculationSettings 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
GetDoubleParameter
Get a named parameter floating point value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
Return value
Type: double
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
Return value
Type: double
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
Return value
Type: float
GetErrorString
Returns a string describing the error that was found the last time ValidateSettings was performed.
Syntax
Parameters
GetErrorString takes no parameters.
Return value
Type: spString
Syntax
Parameters
GetErrorString takes no parameters.
Return value
Type: string
Syntax
Parameters
GetErrorString takes no parameters.
Return value
Type: str
GetIntParameter
Get a named parameter integer value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
Return value
Type: int
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
Return value
Type: int
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
Return value
Type: int
GetStringParameter
Get a named parameter string value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
Return value
Type: spString
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
Return value
Type: string
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
Return value
Type: str
GetUIntParameter
Get a named parameter unsigned integer value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
Return value
Type: unsigned int
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
Return value
Type: uint
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
Return value
Type: int
IsA
Returns true if NormalCalculationSettings 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 NormalCalculationSettings 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 NormalCalculationSettings 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 NormalCalculationSettings is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the NormalCalculationSettings 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 NormalCalculationSettings 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 NormalCalculationSettings 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 NormalCalculationSettings 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. |
SetBoolParameter
Set a named parameter boolean value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
bool | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
bool | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
| value | bool | | | New value for parameter. |
Return value
Type: bool
SetDoubleParameter
Set a named parameter floating point value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
double | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
double | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
| value | float | | | New value for parameter. |
Return value
Type: bool
SetIntParameter
Set a named parameter integer value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
int | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
int | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
| value | int | | | New value for parameter. |
Return value
Type: bool
SetStringParameter
Set a named parameter string value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
const char * | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
string | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
| value | str | | | New value for parameter. |
Return value
Type: bool
SetUIntParameter
Set a named parameter unsigned integer value.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | Parameter name. |
unsigned int | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | Parameter name. |
uint | value | | | New value for parameter. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | Parameter name. |
| value | int | | | New value for parameter. |
Return value
Type: bool
SetValidateParameterNames
Set if parameter names should be validated or not. Parameters that previously do not exist will generate and error if validation is enabled and be allowed if validation is disabled.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
bool | validate | | | Flag indicating if validation is performed or not. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
bool | validate | | | Flag indicating if validation is performed or not. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| validate | bool | | | Flag indicating if validation is performed or not. |
ToJSON
Get settings as JSON for debugging purposes.
Syntax
Parameters
ToJSON takes no parameters.
Return value
Type: spString
Syntax
Parameters
ToJSON takes no parameters.
Return value
Type: string
Syntax
Parameters
ToJSON takes no parameters.
Return value
Type: str
ValidateSettings
Validates the current settings values.
Syntax
Parameters
ValidateSettings takes no parameters.
Return value
Type: bool
Syntax
Parameters
ValidateSettings takes no parameters.
Return value
Type: bool
Syntax
Parameters
ValidateSettings takes no parameters.
Return value
Type: bool
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 spNormalCalculationSettings, and if this is the case, returns the object cast into spNormalCalculationSettings. (Inherited from Object)
