TextureStreamedMapFile

TextureStreamedMapFile#

(Streamed Map File)

Category: /Texture/Map
Default object name: streamed_map_file
Inherits from: ProjectItem > TextureOperator > Texture > TextureSpatial

Description#

Stream an image texture. Tiled textures are supported.

Public Attributes#

Type	Name	Visual Hint	Description
`bool`	`use_texture_aspect_ratio`	`VISUAL_HINT_DEFAULT`	If checked, the texture aspect ratio will be included in the camera projection computation.
`string`	`filename`	`VISUAL_HINT_FILENAME_OPEN`	Set the path to the image file. For tiled texture, use the following tags to specify the place of the texture's coordinates. for Mari's UDIM; for Mudbox' "_uU_vV" naming convention; and for custom naming.
`long`	`missing_file_behavior`	`VISUAL_HINT_DEFAULT`	Choose the default texture or default color when the file has not been found.
`long`	`u_repeat_mode`	`VISUAL_HINT_DEFAULT`	Select the repeat mode on U axis.
`long`	`v_repeat_mode`	`VISUAL_HINT_DEFAULT`	Select the repeat mode on V axis.
`long`	`interpolation_mode`	`VISUAL_HINT_DEFAULT`	Select the image interpolation mode.
`action`	`detect_sequence`	`VISUAL_HINT_DEFAULT`
`long`	`sequence_mode`	`VISUAL_HINT_DEFAULT`	Enable / disable the sequence mode.
`long`	`frame`	`VISUAL_HINT_DEFAULT`	Define the frame to consider. By default it considers the current frame.
`long`	`start_frame`	`VISUAL_HINT_DEFAULT`	In custom frame range mode, set the start frame to use.
`long`	`end_frame`	`VISUAL_HINT_DEFAULT`	In custom frame range mode, set the end frame to use.
`long`	`frame_offset`	`VISUAL_HINT_DEFAULT`	Offsets the time. If the offset is set to 50 and the sequence starts at 10, then the first image will be used at frame 60.
`double`	`frame_rate`	`VISUAL_HINT_FREQUENCY`	Set the frame rate of the sequence.
`long`	`missing_frame`	`VISUAL_HINT_DEFAULT`	Behavior to apply in case an image is missoing. Drop shows nothing, Hold uses the last read image
`long`	`pre_behavior`	`VISUAL_HINT_DEFAULT`	Behavior to apply before the beginning of the sequence. Drop shows nothing, Hold uses the first image, Repeat loops on the sequence.
`long`	`post_behavior`	`VISUAL_HINT_DEFAULT`	Behavior to apply after the end of the sequence. Drop shows nothing, Hold uses the last image, Repeat loops on the sequence.
`bool`	`use_raw_data`	`VISUAL_HINT_DEFAULT`	If checked, raw values of the file will be used. No color space applied.
`bool`	`color_space_auto_detect`	`VISUAL_HINT_DEFAULT`	If checked, auto detect the color space from file.
`string`	`file_color_space`	`VISUAL_HINT_ENUM`	Defines the color space of the file. Values will be converted to linear color space.
`bool`	`pre_multiplied`	`VISUAL_HINT_DEFAULT`	If NOT checked, pre-multiplies the RGB colors by the alpha channel.
`double[3]`	`multiplier_input`	`VISUAL_HINT_COLOR`	Define the input color to multiply.
`bool`	`multiplier_affect_alpha`	`VISUAL_HINT_DEFAULT`	If selected, the alpha channel is affected by the evaluation.
`double[3]`	`gamma_color`	`VISUAL_HINT_COLOR`	Define the gamma applied by color channel.
`double`	`gamma_alpha`	`VISUAL_HINT_PERCENTAGE`	Define the gamma applied to the alpha of the input color.
`long`	`mipmap_mode`	`VISUAL_HINT_DEFAULT`	Select mipmap mode.
`double`	`mipmap_quality`	`VISUAL_HINT_PERCENTAGE`	Influence the mipmap level chosen when rendering. 100% is neutral while 0% asks for lower resolution levels and 200% asks for sharper resolution.
`double`	`maximum_mipmap_level`	`VISUAL_HINT_PERCENTAGE`	Defines the maximum mipmap resolution used when rendering. 100% will allow the use of the highest resolution levels available while 0% will limit the choice to the lowest resolution.
`string`	`output_layer`	`VISUAL_HINT_TAG`	Set the group of channels to read from the file.
`double[3]`	`default_color`	`VISUAL_HINT_COLOR`	Define the default color used if the texture file wasn't found.

Inherited Public Attributes#

Type	Name	Visual Hint	Description
`bool`	`pass_through`	`VISUAL_HINT_DEFAULT`	If checked, the current texture is not evaluated and the value of the attribute selected in Pass Through Attribute is directly forwarded.
`string`	`master_input`	`VISUAL_HINT_TAG`	Name of the attribute that will be used as output if Pass Through is enabled.
`bool`	`invert`	`VISUAL_HINT_DEFAULT`	If checked, the texture is inverted.
`double`	`opacity`	`VISUAL_HINT_PERCENTAGE`	Set the opacity of the texture.
`long`	`projection`	`VISUAL_HINT_DEFAULT`	Define the projection used to evaluate the texture.
`long`	`space`	`VISUAL_HINT_DEFAULT`	Define whether the texture is evaluated in 2D or 3D. In 2D space, the texture is stretched along the projection axis whereas in 3D space all components are used.
`long`	`axis`	`VISUAL_HINT_DEFAULT`	Define the projection axis.
`reference` (`UvSlot`)	`uv_slot`	`VISUAL_HINT_DEFAULT`	Define which UV slot is used when the project mode is set to UV.
`long`	`object_space`	`VISUAL_HINT_DEFAULT`	Set the space in which the object must be considered when computing the projection.
`string`	`reference_positions`	`VISUAL_HINT_TAG`	Set the name of the property that contains reference positions of the geometry that have to be used when computing projections.
`string`	`uv_property`	`VISUAL_HINT_TAG`	Set the name of the property that contains uv's of the geometry that have to be used when computing projections.
`reference` (`Camera`)	`camera`	`VISUAL_HINT_DEFAULT`	Define which camera is used when the texture is in Camera projection mode.
`bool`	`camera_occlusion`	`VISUAL_HINT_DEFAULT`	When on the texture looks for potential occluder between the sample position and the camera. If no occluder is found the sample gets mapped.
`reference` (`Group`)	`camera_occluders`	`VISUAL_HINT_GROUP`	Define which geometries are occluders when camera occlusion is enabled. By default it uses the 3D layer geometries.
`reference` (`SceneItem`)	`reference_object`	`VISUAL_HINT_DEFAULT`	If an object is selected, the texture will use the object's transformation matrix to compute the texture coordinates.
`double[3]`	`projection_translate`	`VISUAL_HINT_DISTANCE`	Offset the position of the projection. Enable with Planar, Cylindrical, Spherical, Cubic.
`double[3]`	`projection_rotate`	`VISUAL_HINT_ANGLE`	Offset the rotation of the projection. Enable with Planar, Cylindrical, Spherical, Cubic.
`double[3]`	`projection_scale`	`VISUAL_HINT_SCALE`	Offset the scaling of the projection. Enable with Planar, Cylindrical, Spherical, Cubic.
`action`	`fit_to_bounding_box`	`VISUAL_HINT_DEFAULT`
`double[3]`	`uv_translate`	`VISUAL_HINT_DISTANCE`	Offset the UV by the specified values in UVW space.
`double[3]`	`uv_rotate`	`VISUAL_HINT_ANGLE`	Rotate the UV by the specified values in UVW space.
`double[3]`	`uv_scale`	`VISUAL_HINT_SCALE`	Scale the UV by the specified values in UVW space.

CID#

class "TextureStreamedMapFile" "TextureSpatial" {
    #version 0.98
    icon "../icons/object_icons/texture_streamed_map_file.iconrc"
    category "/Texture/Map"
    doc "Stream an image texture. Tiled textures are supported."
    attribute_group "projection>camera" {
        bool "use_texture_aspect_ratio" {
            doc "If checked, the texture aspect ratio will be included in the camera projection computation."
            animatable yes
            read_only yes
            value yes
        }
    }
    attribute_group "image" {
        filename_open "filename" {
            doc "Set the path to the image file. For tiled texture, use the following tags to specify the place of the texture\'s coordinates. <UDIM> for Mari\'s UDIM; <UVTILE> for Mudbox\' \"_uU_vV\" naming convention; <U> and <V> for custom naming."
            extension "exr" "tif" "tex" "tx" "hdr" "tga" "png" "jpg" "jpeg" "bmp" "sgi" "psd" "pic"
            shading_variable yes
            value ""
        }
        filename_open "filename_sys" {
            private yes
            saveable no
            value ""
        }
        long "missing_file_behavior" {
            doc "Choose the default texture or default color when the file has not been found."
            preset "Use Default Texture" "0"
            preset "Use Default Color" "1"
            value 0
        }
        long "u_repeat_mode" {
            doc "Select the repeat mode on U axis."
            shading_variable yes
            preset "Repeat" "3"
            preset "Edge" "2"
            preset "Reset" "1"
            preset "Mirror" "4"
            preset "Default" "0"
            value 3
        }
        long "v_repeat_mode" {
            doc "Select the repeat mode on V axis."
            shading_variable yes
            preset "Repeat" "3"
            preset "Edge" "2"
            preset "Reset" "1"
            preset "Mirror" "4"
            preset "Default" "0"
            value 3
        }
        long "interpolation_mode" {
            doc "Select the image interpolation mode."
            shading_variable yes
            preset "Nearest Neighbor" "0"
            preset "Bilinear Filtering" "1"
            preset "Bicubic Filtering" "2"
            preset "Smart Bicubic" "3"
            value 1
        }
    }
    attribute_group "image>sequence" {
        collapsed yes
        action "detect_sequence" {
            value <empty>
        }
        long "sequence_mode" {
            doc "Enable / disable the sequence mode."
            preset "Still" "0"
            preset "Sequence" "1"
            value 0
        }
        long "frame" {
            doc "Define the frame to consider. By default it considers the current frame."
            null_label "Use Application Frame"
            null_value "2147483647"
            texturable yes
            ui_range yes -1000 1000
            read_only yes
            value 2147483647
        }
        long "start_frame" {
            doc "In custom frame range mode, set the start frame to use."
            read_only yes
            value 0
        }
        long "end_frame" {
            doc "In custom frame range mode, set the end frame to use."
            read_only yes
            value 1
        }
        long "frame_offset" {
            doc "Offsets the time. If the offset is set to 50 and the sequence starts at 10, then the first image will be used at frame 60."
            ui_range yes -1000 1000
            read_only yes
            value 0
        }
        frequency "frame_rate" {
            doc "Set the frame rate of the sequence."
            numeric_range yes 0.1 200
            ui_range yes 0.1 60
            read_only yes
            value 30
        }
        long "missing_frame" {
            doc "Behavior to apply in case an image is missoing. Drop shows nothing, Hold uses the last read image"
            read_only yes
            preset "Drop" "0"
            preset "Hold" "1"
            value 1
        }
        long "pre_behavior" {
            doc "Behavior to apply before the beginning of the sequence. Drop shows nothing, Hold uses the first image, Repeat loops on the sequence."
            read_only yes
            preset "Drop" "0"
            preset "Hold" "1"
            preset "Loop" "2"
            value 0
        }
        long "post_behavior" {
            doc "Behavior to apply after the end of the sequence. Drop shows nothing, Hold uses the last image, Repeat loops on the sequence."
            read_only yes
            preset "Drop" "0"
            preset "Hold" "1"
            preset "Loop" "2"
            value 0
        }
    }
    attribute_group "image>color_management" {
        collapsed yes
        bool "use_raw_data" {
            doc "If checked, raw values of the file will be used. No color space applied."
            shading_variable yes
            value no
        }
        bool "color_space_auto_detect" {
            doc "If checked, auto detect the color space from file."
            value no
        }
        enum "file_color_space" {
            doc "Defines the color space of the file. Values will be converted to linear color space."
            filter "color_space"
            shading_variable yes
            value "__invalid_enum_label__"
        }
        bool "pre_multiplied" {
            doc "If NOT checked, pre-multiplies the RGB colors by the alpha channel."
            animatable yes
            shading_variable yes
            value yes
        }
    }
    attribute_group "image>color_correction" {
        collapsed yes
        color "multiplier_input" {
            doc "Define the input color to multiply."
            texturable yes
            animatable yes
            value 1 1 1
        }
        bool "multiplier_affect_alpha" {
            doc "If selected, the alpha channel is affected by the evaluation."
            animatable yes
            value no
        }
        color "gamma_color" {
            doc "Define the gamma applied by color channel."
            texturable yes
            animatable yes
            value 1 1 1
        }
        percentage "gamma_alpha" {
            doc "Define the gamma applied to the alpha of the input color."
            texturable yes
            animatable yes
            value 1
        }
    }
    attribute_group "image>mip-mapping" {
        collapsed yes
        long "mipmap_mode" {
            doc "Select mipmap mode."
            shading_variable yes
            preset "Default" "0"
            preset "None" "1"
            preset "One" "2"
            preset "Trilinear" "3"
            preset "Anisotropic" "4"
            value 0
        }
        percentage "mipmap_quality" {
            doc "Influence the mipmap level chosen when rendering. 100% is neutral while 0% asks for lower resolution levels and 200% asks for sharper resolution."
            slider yes
            numeric_range yes 0.0 2
            ui_range yes 0.0 2
            value 1
        }
        percentage "maximum_mipmap_level" {
            doc "Defines the maximum mipmap resolution used when rendering. 100% will allow the use of the highest resolution levels available while 0% will limit the choice to the lowest resolution."
            slider yes
            numeric_range yes 0.0 1
            ui_range yes 0.0 1
            value 1
        }
    }
    attribute_group "output" {
        tag "output_layer" {
            doc "Set the group of channels to read from the file."
            filter "channel_groups"
            shading_variable yes
            preset "all" "-1"
            preset "rgba" "0"
            preset "coordinates" "1"
            preset "diagnostics_pbr_diffuse_sample-count" "2"
            preset "diagnostics_pbr_diffuse_sample-count_transmission" "3"
            preset "diagnostics_pbr_diffuse_sample-count_reflection" "4"
            preset "diagnostics_pbr_glossy_sample-count" "5"
            preset "diagnostics_pbr_glossy_sample-count_transmission" "6"
            preset "diagnostics_pbr_glossy_sample-count_reflection" "7"
            preset "diagnostics_pbr_specular_sample-count" "8"
            preset "diagnostics_pbr_specular_sample-count_transmission" "9"
            preset "diagnostics_pbr_specular_sample-count_reflection" "10"
            preset "diagnostics_pbr_spec-gloss_sample-count" "11"
            preset "diagnostics_pbr_spec-gloss_sample-count_transmission" "12"
            preset "diagnostics_pbr_spec-gloss_sample-count_reflection" "13"
            preset "diagnostics_pbr_subsurface_sample-count" "14"
            preset "diagnostics_pbr_volume_sample-count" "15"
            preset "diagnostics_pbr_light_sample-count" "16"
            preset "motion_vector" "17"
            preset "camera_normal" "18"
            preset "camera_position" "19"
            preset "world_normal" "20"
            preset "albedo" "21"
            preset "depth" "22"
            preset "pbr_diffuse" "23"
            preset "pbr_diffuse_transmission" "24"
            preset "pbr_diffuse_transmission_k" "25"
            preset "pbr_diffuse_transmission_i" "26"
            preset "pbr_diffuse_transmission_i_direct" "27"
            preset "pbr_diffuse_transmission_i_indirect" "28"
            preset "pbr_diffuse_reflection" "29"
            preset "pbr_diffuse_reflection_k" "30"
            preset "pbr_diffuse_reflection_i" "31"
            preset "pbr_diffuse_reflection_i_direct" "32"
            preset "pbr_diffuse_reflection_i_indirect" "33"
            preset "pbr_glossy" "34"
            preset "pbr_glossy_transmission" "35"
            preset "pbr_glossy_transmission_k" "36"
            preset "pbr_glossy_transmission_i" "37"
            preset "pbr_glossy_transmission_i_direct" "38"
            preset "pbr_glossy_transmission_i_indirect" "39"
            preset "pbr_glossy_reflection" "40"
            preset "pbr_glossy_reflection_k" "41"
            preset "pbr_glossy_reflection_i" "42"
            preset "pbr_glossy_reflection_i_direct" "43"
            preset "pbr_glossy_reflection_i_indirect" "44"
            preset "pbr_specular" "45"
            preset "pbr_specular_transmission" "46"
            preset "pbr_specular_transmission_k" "47"
            preset "pbr_specular_transmission_i" "48"
            preset "pbr_specular_reflection" "49"
            preset "pbr_specular_reflection_k" "50"
            preset "pbr_specular_reflection_i" "51"
            preset "pbr_spec-gloss" "52"
            preset "pbr_spec-gloss_transmission" "53"
            preset "pbr_spec-gloss_reflection" "54"
            preset "pbr_subsurface" "55"
            preset "pbr_subsurface_k" "56"
            preset "pbr_subsurface_i" "57"
            preset "pbr_subsurface_i_direct" "58"
            preset "pbr_subsurface_i_indirect" "59"
            preset "pbr_volume" "60"
            preset "pbr_volume_k" "61"
            preset "pbr_volume_i" "62"
            preset "pbr_volume_i_direct" "63"
            preset "pbr_volume_i_indirect" "64"
            preset "pbr_emission" "65"
            preset "pbr_light_direction" "66"
            preset "pbr_light_radiance" "67"
            preset "luminosity" "68"
            preset "opacity" "69"
            preset "pbr_volume_density" "70"
            preset "pbr_volume_attenuation" "71"
            preset "pbr_catcher_opacity" "72"
            preset "pbr_catcher_diffuse" "73"
            preset "pbr_catcher_diffuse_transmission" "74"
            preset "pbr_catcher_diffuse_reflection" "75"
            preset "pbr_catcher_glossy" "76"
            preset "pbr_catcher_glossy_transmission" "77"
            preset "pbr_catcher_glossy_reflection" "78"
            preset "pbr_catcher_specular" "79"
            preset "pbr_catcher_specular_transmission" "80"
            preset "pbr_catcher_specular_reflection" "81"
            preset "pbr_catcher_spec-gloss" "82"
            preset "pbr_catcher_spec-gloss_transmission" "83"
            preset "pbr_catcher_spec-gloss_reflection" "84"
            preset "pbr_catcher_subsurface" "85"
            preset "pbr_catcher_volume" "86"
            preset "diagnostics_ray-count" "87"
            preset "diagnostics_camera_sample-count" "88"
            preset "diagnostics_camera_heat-map" "89"
            preset "cryptomatte_material" "90"
            preset "cryptomatte_material00" "91"
            preset "cryptomatte_material01" "92"
            preset "cryptomatte_material02" "93"
            preset "cryptomatte_object" "94"
            preset "cryptomatte_object00" "95"
            preset "cryptomatte_object01" "96"
            preset "cryptomatte_object02" "97"
            preset "cryptomatte_asset" "98"
            preset "cryptomatte_asset00" "99"
            preset "cryptomatte_asset01" "100"
            preset "cryptomatte_asset02" "101"
            preset "lpe_diffuse_reflection_albedo" "102"
            preset "lpe_diffuse_reflection_direct" "103"
            preset "lpe_diffuse_reflection_indirect" "104"
            preset "lpe_diffuse_transmission_albedo" "105"
            preset "lpe_diffuse_transmission_direct" "106"
            preset "lpe_diffuse_transmission_indirect" "107"
            preset "lpe_direct" "108"
            preset "lpe_glossy_reflection_albedo" "109"
            preset "lpe_glossy_reflection_direct" "110"
            preset "lpe_glossy_reflection_indirect" "111"
            preset "lpe_glossy_transmission_albedo" "112"
            preset "lpe_glossy_transmission_direct" "113"
            preset "lpe_glossy_transmission_indirect" "114"
            preset "lpe_indirect" "115"
            preset "lpe_spec-gloss_reflection_albedo" "116"
            preset "lpe_spec-gloss_reflection_direct" "117"
            preset "lpe_spec-gloss_reflection_indirect" "118"
            preset "lpe_spec-gloss_transmission_albedo" "119"
            preset "lpe_spec-gloss_transmission_direct" "120"
            preset "lpe_spec-gloss_transmission_indirect" "121"
            preset "lpe_specular_reflection_albedo" "122"
            preset "lpe_specular_reflection_direct" "123"
            preset "lpe_specular_reflection_indirect" "124"
            preset "lpe_specular_transmission_albedo" "125"
            preset "lpe_specular_transmission_direct" "126"
            preset "lpe_specular_transmission_indirect" "127"
            preset "lpe_subsurface_albedo" "128"
            preset "lpe_subsurface_direct" "129"
            preset "lpe_subsurface_indirect" "130"
            preset "lpe_volume_albedo" "131"
            preset "lpe_volume_direct" "132"
            preset "lpe_volume_indirect" "133"
            value "rgba"
        }
        color "default_color" {
            doc "Define the default color used if the texture file wasn\'t found."
            texturable yes
            animatable yes
            value 0.0 0.0 0.0
        }
    }
    set "master_input" {
        private no
        hidden no
        saveable yes
        texturable no
        animatable no
        slider no
        numeric_range no 0.0 1
        ui_range no 0.0 1
        dg_active yes
        dg_cyclic no
        dirtiness_pass_through no
        read_only no
        shading_variable no
        experimental no
        advanced no
        overriden no
        promote_attribute no
        allow_expression yes
        localizable yes
        value "multiplier_input"
    }
}