Node Group Projector Parameter - anticto/Mutable-Documentation GitHub Wiki

Function

Projects one or many textures to all children in the group it's connected to. It modifies only the materials that define a specific material asset texture parameter.

Node Properties

  • Copy (button): Utility for copying the current transform seen in the Preview Instance Viewport. Useful for applying the same transform to different projectors or to manually save a copy of the current transform before trying some new location.

  • Paste (button): Utility for pasting the output of a projector copy button. It allows to set this projector transform the same as the one copied from.

  • Material Channel Name to Connect: The name of the material asset texture parameter that is modified to print the projectors. It must be defined in the materials of the group that want to receive projectors from this group.

  • Masked Out Area Material Channel Name: The name of the material asset texture parameter that defines where can projectors be printed. It must be defined in the materials of the group that want to prevent some of their surface to receive projectors. White where they can be placed, black where can't have any impact, and grayscale for partial projector application.

  • Reference Texture: Texture that defines the final texture configuration (its not projected in any way). See Reference Texture section below.

  • Projection Texture Size: Resolution of the final projection texture generated by the node.

  • Option Textures (array): The different textures that will be projected. There has to be at least one in order to project anything. Each option can be used more than once, so there's no need to have duplicate options to project multiple times the same texture. Also, multiple different options can be used at the same time.

  • Option Name (array item): Name of this particular projection texture.

  • Option Texture (array item): Texture asset that is projected when this option is chosen.

  • Option Poses (array): Poses different from the T-Pose that are used while projecting. It's optional, leave empty if it's not used. Defines an integer parameter named after this projector node with "_SelectedPoses" appended, like this: For a Group Projector Node named "ClothesStickers" it defines an integer property named "ClothesStickers_SelectedPoses". That parameter is intended for internal use only, by the game programmers. When this projectors are to be modified in a non T-Pose, this parameter should be set after the property "Option Name" that refers to the Pose Asset that was created from the pose currently in use.

  • Pose Name (array item): Friendly name of the pose. It's used to tell Mutable what pose to use when projecting this node projectors.

  • Option Pose (array item): Pose asset used for projecting when this option is chosen.

  • Data Table Texture Column Name: Name of the column that contains the Texture2D references in the Option Textures Data Table node property.

  • Option Textures Data Table: Table asset containing texture references to use for projection, that can be shared among different Group Projector nodes. The row names will be used as Option Names for the corresponding texture. If any row name is already defined as option name, the data table texture takes precedence over the option texture.

  • Alternate Projection Resolution State Name: Name of the state of this Customizable Object that uses the factor defined at the property "Alternate Projection Resolution Factor" to modify the resolution defined at "Projection Texture Size" . It's optional, can be left empty if this node resulting texture does not need to change between states.

  • Alternate Projection Resolution Factor: Factor by which to multiply the resolution defined at the property "Projection Texture Size" when the instance uses the state defined at "Alternate Projection Resolution State Name".

WARNING: The intended use of the alternate projection resolution is to better control the detail of the projector in some cases. There are two main use cases: Using a factor greater than one in the state where this projectors are modified, or using a factor lower than one in the playing state.

  • Projector Bone (dropdown): Utility for setting the gizmo location and rotation to match the chosen bone. Really helpful for cylindrical projectors.

  • Parameter Name: Name of the group projector parameter defined by the node. It has to be unique within all the parameters in this customizable object hierarchy. Used when coding or within blueprints to refer to this parameter.

  • Projector Type (dropdown): Allows choosing between planar, wrapping and cylindrical projectors. Planar projectors are best on more or less flat surfaces. Wrapping projectors are intended to use on top of more complex geometry. Cylindrical projectors are intended to use as wrap around elongated sections of mesh smaller than the projector radius.

  • Projection Angle (degrees): When a cylindrical projector is chosen, defines the angle around which the texture will be stretched. An angle of 360ยบ means that the texture will wrap around and the ends will touch at the back. This parameter has no effect if other type of projector is chosen.

  • Parameter UI Metadata: Metadata associated to this group projector parameter.

(red 3D gizmo): Used to define the projector default transformation: location, rotation and scale.

For planar and wrapping projectors: The red box defines the volume that will be affected by default by the projector. This can change at runtime when the parameter is modified.

For cylindrical projectors: The red cylinder defines the volume that will be affected by the projector. It is further limited by the projection angle. Both can change at runtime when the parameter is modified.

Output Pins

Value: This node will only be activated only if is connected to a Object Group node.

Reference Texture

These are the texture properties copied from the Reference Texture to the final projected texture:

  • Compression Settings
  • Max Texture Size
  • sRGB
  • Filter
  • MIP Generation Settings
  • LOD Bias
  • Texture Group