Simplygon 10.2.400.0

Appearance

On this page

class BoneSettings ​

Settings for the Simplygon Reduction/Remeshing classes With the BoneSettings object, the user can setup all the parameters for how the BoneLOD processor should simplify the links between geometries and bones. Bones can be un-linked from the geometry either with a set ratio or depending on a selected pixel size on screen.

Properties ​

PropertyDescription
BoneReductionTargetBoneCountThe desired bone count. The range is 0->inf.
BoneReductionTargetBoneCountEnabledEnable bone count as a reduction target. The reducer will stop when the set bone count has been reached.
BoneReductionTargetBoneRatioThe desired bone reduction ratio. The range is 0->1.
BoneReductionTargetBoneRatioEnabledEnable bone ratio as a reduction target. The reducer will stop when the set bone-ratio has been reached.
BoneReductionTargetMaxDeviationThe MaxDeviation value, the maximum surface-deviation between the reduced geometry and the original.
BoneReductionTargetMaxDeviationEnabledEnable max deviation as a reduction target. The reducer will stop when the set max deviation has been reached.
BoneReductionTargetOnScreenSizeThe OnScreenSize value, the maximum surface-deviation between the reduced geometry and the original.
BoneReductionTargetOnScreenSizeEnabledEnable on screen size as a reduction target. The reducer will stop when the set on screen size has been reached.
BoneReductionTargetStopConditionThe stop condition for the bone reducer. Any: the reducer will stop when any single one of the set reduction targets have been reached. All: the reducer will stop when all enabled reduction targets have been set.
LimitBonesPerVertexDecides whether unused bones should be removed.
LockBoneSelectionSetIDThe ID of the selection set that contains all of the bones that will be locked, and cannot be removed in the BoneLOD process. If a bone is locked, all its ancestors will be locked also. If the ID is -1, then no bones are selected.
LockBoneSelectionSetNameThe name of the selection set that contains all of the bones that will be locked, and cannot be removed in the BoneLOD process. If a bone is locked, all its ancestors will be locked also. If both name and id are set for the locked selection set, the name will be used.
MaxBonePerVertexDecides the maximum limit of how many bones can be connected to each vertex. If for example set to 1, then each vertex will only be linked to 1 bone.
NameThe name of the BoneSettings object. (Inherited from Object)
RemoveBoneSelectionSetIDThe ID of the selection set that contains all of the bones that will be forced to be removed in the BoneLOD process, UNLESS they are locked. If a bone is set to be removed, all its descendants will be removed also. If both name and id are set for the remove selection set, the name will be used.
RemoveBoneSelectionSetNameThe name of the selection set that contains all of the bones that will be forced to be removed in the BoneLOD process, UNLESS they are locked. If a bone is set to be removed, all its descendants will be removed also. If both name and id are set for the remove selection set, the name will be used.
RemoveUnusedBonesDecides whether unused bones should be removed.
UseBoneReducerEnables or disables the bone reduction processing that actually removes bones. Even with this flag off, the bones per vertex can still be limited.

Methods ​

MethodDescription
AddObserverAdds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
GetBoolParameterGet a named parameter boolean value. (Inherited from SettingsObject)
GetClassGet the name of the BoneSettings class. (Inherited from Object)
GetDoubleParameterGet a named parameter floating point value. (Inherited from SettingsObject)
GetErrorStringReturns a string describing the error that was found the last time ValidateSettings was performed. (Inherited from SettingsObject)
GetIntParameterGet a named parameter integer value. (Inherited from SettingsObject)
GetStringParameterGet a named parameter string value. (Inherited from SettingsObject)
GetUIntParameterGet a named parameter unsigned integer value. (Inherited from SettingsObject)
IsAReturns true if BoneSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNullReturns true if the BoneSettings object is invalid. (Inherited from Object)
IsSameObjectAsReturns true if the BoneSettings object is valid. (Inherited from Object)
NonNullReturns true if the BoneSettings object is valid. (Inherited from Object)
PrintInfoPrints the content/info of the BoneSettings object to the log. (Inherited from Object)
RemoveObserverRemoves a previously added observer object. (Inherited from Object)
SetBoneReductionTargetsSet bone reduction targets and stop condition used in the bone reduction.
SetBoolParameterSet a named parameter boolean value. (Inherited from SettingsObject)
SetDoubleParameterSet a named parameter floating point value. (Inherited from SettingsObject)
SetIntParameterSet a named parameter integer value. (Inherited from SettingsObject)
SetStringParameterSet a named parameter string value. (Inherited from SettingsObject)
SetUIntParameterSet a named parameter unsigned integer value. (Inherited from SettingsObject)
SetValidateParameterNamesSet 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)
ToJSONGet settings as JSON for debugging purposes. (Inherited from SettingsObject)
ValidateSettingsValidates the current settings values. (Inherited from SettingsObject)

Static methods ​

MethodDescription
IsClassAReturns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
SafeCastSafeCast makes sure the input object is of a class that can be cast into spBoneSettings, and if this is the case, returns the object cast into spBoneSettings. (Inherited from Object)

Properties details ​

BoneReductionTargetBoneCount ​

The desired bone count. The range is 0->inf.

BoneReductionTargetBoneCountEnabled ​

Enable bone count as a reduction target. The reducer will stop when the set bone count has been reached.

BoneReductionTargetBoneRatio ​

The desired bone reduction ratio. The range is 0->1.

BoneReductionTargetBoneRatioEnabled ​

Enable bone ratio as a reduction target. The reducer will stop when the set bone-ratio has been reached.

BoneReductionTargetMaxDeviation ​

The MaxDeviation value, the maximum surface-deviation between the reduced geometry and the original.

BoneReductionTargetMaxDeviationEnabled ​

Enable max deviation as a reduction target. The reducer will stop when the set max deviation has been reached.

BoneReductionTargetOnScreenSize ​

The OnScreenSize value, the maximum surface-deviation between the reduced geometry and the original.

BoneReductionTargetOnScreenSizeEnabled ​

Enable on screen size as a reduction target. The reducer will stop when the set on screen size has been reached.

BoneReductionTargetStopCondition ​

The stop condition for the bone reducer. Any: the reducer will stop when any single one of the set reduction targets have been reached. All: the reducer will stop when all enabled reduction targets have been set.

LimitBonesPerVertex ​

Decides whether unused bones should be removed.

LockBoneSelectionSetID ​

The ID of the selection set that contains all of the bones that will be locked, and cannot be removed in the BoneLOD process. If a bone is locked, all its ancestors will be locked also. If the ID is -1, then no bones are selected.

LockBoneSelectionSetName ​

The name of the selection set that contains all of the bones that will be locked, and cannot be removed in the BoneLOD process. If a bone is locked, all its ancestors will be locked also. If both name and id are set for the locked selection set, the name will be used.

MaxBonePerVertex ​

Decides the maximum limit of how many bones can be connected to each vertex. If for example set to 1, then each vertex will only be linked to 1 bone.

Name ​

The name of the BoneSettings object. (Inherited from Object)

RemoveBoneSelectionSetID ​

The ID of the selection set that contains all of the bones that will be forced to be removed in the BoneLOD process, UNLESS they are locked. If a bone is set to be removed, all its descendants will be removed also. If both name and id are set for the remove selection set, the name will be used.

RemoveBoneSelectionSetName ​

The name of the selection set that contains all of the bones that will be forced to be removed in the BoneLOD process, UNLESS they are locked. If a bone is set to be removed, all its descendants will be removed also. If both name and id are set for the remove selection set, the name will be used.

RemoveUnusedBones ​

Decides whether unused bones should be removed.

UseBoneReducer ​

Enables or disables the bone reduction processing that actually removes bones. Even with this flag off, the bones per vertex can still be limited.

Methods details ​

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.

GetClass ​

Get the name of the BoneSettings class. (Inherited from Object)

GetDoubleParameter ​

Get a named parameter floating point value.

GetErrorString ​

Returns a string describing the error that was found the last time ValidateSettings was performed.

GetIntParameter ​

Get a named parameter integer value.

GetStringParameter ​

Get a named parameter string value.

GetUIntParameter ​

Get a named parameter unsigned integer value.

IsA ​

Returns true if BoneSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object)

IsNull ​

Returns true if the BoneSettings object is invalid. (Inherited from Object)

IsSameObjectAs ​

Returns true if the BoneSettings object is valid. (Inherited from Object)

NonNull ​

Returns true if the BoneSettings object is valid. (Inherited from Object)

PrintInfo ​

Prints the content/info of the BoneSettings object to the log. (Inherited from Object)

RemoveObserver ​

Removes a previously added observer object. (Inherited from Object)

SetBoneReductionTargets ​

Set bone reduction targets and stop condition used in the bone reduction.

SetBoolParameter ​

Set a named parameter boolean value.

SetDoubleParameter ​

Set a named parameter floating point value.

SetIntParameter ​

Set a named parameter integer value.

SetStringParameter ​

Set a named parameter string value.

SetUIntParameter ​

Set a named parameter unsigned integer value.

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.

ToJSON ​

Get settings as JSON for debugging purposes.

ValidateSettings ​

Validates the current settings values.

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)

SafeCast ​

SafeCast makes sure the input object is of a class that can be cast into spBoneSettings, and if this is the case, returns the object cast into spBoneSettings. (Inherited from Object)