# class FlipbookSettings

Settings for the ImpostorType: FlipBook

# Properties

Property Description
NumberOfViews Determines the number of views generated for the flip book impostor.
UpVector The views are rotated around the up vector and the rendered images are oriented with the up vector.
UpVectorX The views are rotated around the up vector and the rendered images are oriented with the up vector.
UpVectorY The views are rotated around the up vector and the rendered images are oriented with the up vector.
UpVectorZ The views are rotated around the up vector and the rendered images are oriented with the up vector.
VerticalAngle Deprecated: Use ViewDirection and UpVector instead.
ViewDirection This vector determines the direction of the first view. The rest of the views are uniformly distributed around the scene rotated around the up-vector. The resulting billboard will be oriented in the negative view direction.
ViewDirectionX The X component of the ViewDirection vector. The ViewDirection determines the direction of the first view. The rest of the views are uniformly distributed around the scene rotated around the up-vector. The resulting billboard will be oriented in the negative view direction.
ViewDirectionY The Y component of the ViewDirection vector. The ViewDirection determines the direction of the first view. The rest of the views are uniformly distributed around the scene rotated around the up-vector. The resulting billboard will be oriented in the negative view direction.
ViewDirectionZ The Z component of the ViewDirection vector. The ViewDirection determines the direction of the first view. The rest of the views are uniformly distributed around the scene rotated around the up-vector. The resulting billboard will be oriented in the negative view direction.

# Methods

Method Description
GetBoolParameter Get a named parameter boolean value.
GetClass Get the name of the FlipbookSettings class.
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 FlipbookSettings is a or is a descendant of the class named as the type parameter.
IsNull Returns true if the FlipbookSettings object is invalid.
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

Method Description
IsClassA Returns true if the class is a or is a descendant of the class named as the type parameter.
SafeCast SafeCast makes sure the input object is of a class that can be cast into spFlipbookSettings, and if this is the case, returns the object cast into spFlipbookSettings.

# Properties details

# NumberOfViews

Determines the number of views generated for the flip book impostor.

    # UpVector

    The views are rotated around the up vector and the rendered images are oriented with the up vector.

      # UpVectorX

      The views are rotated around the up vector and the rendered images are oriented with the up vector.

        # UpVectorY

        The views are rotated around the up vector and the rendered images are oriented with the up vector.

          # UpVectorZ

          The views are rotated around the up vector and the rendered images are oriented with the up vector.

            # VerticalAngle

            Deprecated: Use ViewDirection and UpVector instead.

            WARNING

            This property is marked as deprecated and will be removed in a future version.

            Use ViewDirection instead.

              # ViewDirection

              This vector determines the direction of the first view. The rest of the views are uniformly distributed around the scene rotated around the up-vector. The resulting billboard will be oriented in the negative view direction.

                # ViewDirectionX

                The X component of the ViewDirection vector. The ViewDirection determines the direction of the first view. The rest of the views are uniformly distributed around the scene rotated around the up-vector. The resulting billboard will be oriented in the negative view direction.

                  # ViewDirectionY

                  The Y component of the ViewDirection vector. The ViewDirection determines the direction of the first view. The rest of the views are uniformly distributed around the scene rotated around the up-vector. The resulting billboard will be oriented in the negative view direction.

                    # ViewDirectionZ

                    The Z component of the ViewDirection vector. The ViewDirection determines the direction of the first view. The rest of the views are uniformly distributed around the scene rotated around the up-vector. The resulting billboard will be oriented in the negative view direction.

                      # Methods details

                      # GetBoolParameter

                      Get a named parameter boolean value.

                        # GetClass

                        Get the name of the FlipbookSettings class.

                          # 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 FlipbookSettings is a or is a descendant of the class named as the type parameter.

                                      # IsNull

                                      Returns true if the FlipbookSettings object is invalid.

                                        # 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.

                                                          # SafeCast

                                                          SafeCast makes sure the input object is of a class that can be cast into spFlipbookSettings, and if this is the case, returns the object cast into spFlipbookSettings.