materialDefinition.cpp 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749
  1. //-----------------------------------------------------------------------------
  2. // Copyright (c) 2012 GarageGames, LLC
  3. //
  4. // Permission is hereby granted, free of charge, to any person obtaining a copy
  5. // of this software and associated documentation files (the "Software"), to
  6. // deal in the Software without restriction, including without limitation the
  7. // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  8. // sell copies of the Software, and to permit persons to whom the Software is
  9. // furnished to do so, subject to the following conditions:
  10. //
  11. // The above copyright notice and this permission notice shall be included in
  12. // all copies or substantial portions of the Software.
  13. //
  14. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16. // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17. // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18. // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  19. // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  20. // IN THE SOFTWARE.
  21. //-----------------------------------------------------------------------------
  22. #include "platform/platform.h"
  23. #include "materials/materialDefinition.h"
  24. #include "console/consoleTypes.h"
  25. #include "console/engineAPI.h"
  26. #include "math/mathTypes.h"
  27. #include "materials/materialManager.h"
  28. #include "sceneData.h"
  29. #include "gfx/sim/cubemapData.h"
  30. #include "gfx/gfxCubemap.h"
  31. #include "math/mathIO.h"
  32. #include "materials/matInstance.h"
  33. #include "sfx/sfxTrack.h"
  34. #include "sfx/sfxTypes.h"
  35. #include "core/util/safeDelete.h"
  36. #include "T3D/accumulationVolume.h"
  37. IMPLEMENT_CONOBJECT( Material );
  38. ConsoleDocClass( Material,
  39. "@brief A material in Torque 3D is a data structure that describes a surface.\n\n"
  40. "It contains many different types of information for rendering properties. "
  41. "Torque 3D generates shaders from Material definitions. The shaders are compiled "
  42. "at runtime and output into the example/shaders directory. Any errors or warnings "
  43. "generated from compiling the procedurally generated shaders are output to the console "
  44. "as well as the output window in the Visual C IDE.\n\n"
  45. "@tsexample\n"
  46. "singleton Material(DECAL_scorch)\n"
  47. "{\n"
  48. " baseTex[0] = \"./scorch_decal.png\";\n"
  49. " vertColor[ 0 ] = true;\n\n"
  50. " translucent = true;\n"
  51. " translucentBlendOp = None;\n"
  52. " translucentZWrite = true;\n"
  53. " alphaTest = true;\n"
  54. " alphaRef = 84;\n"
  55. "};\n"
  56. "@endtsexample\n\n"
  57. "@see Rendering\n"
  58. "@see ShaderData\n"
  59. "@ingroup GFX\n");
  60. ImplementBitfieldType( MaterialAnimType,
  61. "The type of animation effect to apply to this material.\n"
  62. "@ingroup GFX\n\n")
  63. { Material::Scroll, "Scroll", "Scroll the material along the X/Y axis.\n" },
  64. { Material::Rotate, "Rotate" , "Rotate the material around a point.\n"},
  65. { Material::Wave, "Wave" , "Warps the material with an animation using Sin, Triangle or Square mathematics.\n"},
  66. { Material::Scale, "Scale", "Scales the material larger and smaller with a pulsing effect.\n" },
  67. { Material::Sequence, "Sequence", "Enables the material to have multiple frames of animation in its imagemap.\n" }
  68. EndImplementBitfieldType;
  69. ImplementEnumType( MaterialBlendOp,
  70. "The type of graphical blending operation to apply to this material\n"
  71. "@ingroup GFX\n\n")
  72. { Material::None, "None", "Disable blending for this material." },
  73. { Material::Mul, "Mul", "Multiplicative blending." },
  74. { Material::Add, "Add", "Adds the color of the material to the frame buffer with full alpha for each pixel." },
  75. { Material::AddAlpha, "AddAlpha", "The color is modulated by the alpha channel before being added to the frame buffer." },
  76. { Material::Sub, "Sub", "Subtractive Blending. Reverses the color model, causing dark colors to have a stronger visual effect." },
  77. { Material::LerpAlpha, "LerpAlpha", "Linearly interpolates between Material color and frame buffer color based on alpha." }
  78. EndImplementEnumType;
  79. ImplementEnumType( MaterialWaveType,
  80. "When using the Wave material animation, one of these Wave Types will be used to determine the type of wave to display.\n"
  81. "@ingroup GFX\n")
  82. { Material::Sin, "Sin", "Warps the material along a curved Sin Wave." },
  83. { Material::Triangle, "Triangle", "Warps the material along a sharp Triangle Wave." },
  84. { Material::Square, "Square", "Warps the material along a wave which transitions between two oppposite states. As a Square Wave, the transition is quick and sudden." },
  85. EndImplementEnumType;
  86. bool Material::sAllowTextureTargetAssignment = false;
  87. GFXCubemap * Material::GetNormalizeCube()
  88. {
  89. if(smNormalizeCube)
  90. return smNormalizeCube;
  91. smNormalizeCube = GFX->createCubemap();
  92. smNormalizeCube->initNormalize(64);
  93. return smNormalizeCube;
  94. }
  95. GFXCubemapHandle Material::smNormalizeCube;
  96. Material::Material()
  97. {
  98. for( U32 i=0; i<MAX_STAGES; i++ )
  99. {
  100. mDiffuse[i].set( 1.0f, 1.0f, 1.0f, 1.0f );
  101. mDiffuseMapSRGB[i] = true;
  102. mSmoothness[i] = 0.0f;
  103. mMetalness[i] = 0.0f;
  104. mIsSRGb[i] = false;
  105. mInvertSmoothness[i] = false;
  106. mSmoothnessChan[i] = 0;
  107. mAOChan[i] = 1;
  108. mMetalChan[i] = 2;
  109. mAccuEnabled[i] = false;
  110. mAccuScale[i] = 1.0f;
  111. mAccuDirection[i] = 1.0f;
  112. mAccuStrength[i] = 0.6f;
  113. mAccuCoverage[i] = 0.9f;
  114. mAccuSpecular[i] = 16.0f;
  115. mParallaxScale[i] = 0.0f;
  116. mVertLit[i] = false;
  117. mVertColor[ i ] = false;
  118. mGlow[i] = false;
  119. mEmissive[i] = false;
  120. mDetailScale[i].set( 2.0f, 2.0f );
  121. mDetailNormalMapStrength[i] = 1.0f;
  122. mMinnaertConstant[i] = -1.0f;
  123. mSubSurface[i] = false;
  124. mSubSurfaceColor[i].set( 1.0f, 0.2f, 0.2f, 1.0f );
  125. mSubSurfaceRolloff[i] = 0.2f;
  126. mAnimFlags[i] = 0;
  127. mScrollDir[i].set( 0.0f, 0.0f );
  128. mScrollSpeed[i] = 0.0f;
  129. mScrollOffset[i].set( 0.0f, 0.0f );
  130. mRotSpeed[i] = 0.0f;
  131. mRotPivotOffset[i].set( 0.0f, 0.0f );
  132. mRotPos[i] = 0.0f;
  133. mWavePos[i] = 0.0f;
  134. mWaveFreq[i] = 0.0f;
  135. mWaveAmp[i] = 0.0f;
  136. mWaveType[i] = 0;
  137. mSeqFramePerSec[i] = 0.0f;
  138. mSeqSegSize[i] = 0.0f;
  139. // Deferred Shading
  140. mMatInfoFlags[i] = 0.0f;
  141. mRoughMapFilename[i].clear();
  142. mAOMapFilename[i].clear();
  143. mMetalMapFilename[i].clear();
  144. }
  145. dMemset(mCellIndex, 0, sizeof(mCellIndex));
  146. dMemset(mCellLayout, 0, sizeof(mCellLayout));
  147. dMemset(mCellSize, 0, sizeof(mCellSize));
  148. dMemset(mNormalMapAtlas, 0, sizeof(mNormalMapAtlas));
  149. dMemset(mUseAnisotropic, 0, sizeof(mUseAnisotropic));
  150. // Deferred Shading : Metalness
  151. dMemset(mUseMetalness, 0, sizeof(mUseMetalness));
  152. mImposterLimits = Point4F::Zero;
  153. mDoubleSided = false;
  154. mTranslucent = false;
  155. mTranslucentBlendOp = LerpAlpha;
  156. mTranslucentZWrite = false;
  157. mAlphaTest = false;
  158. mAlphaRef = 1;
  159. mCastShadows = true;
  160. mCastDynamicShadows = false;
  161. mPlanarReflection = false;
  162. mCubemapData = NULL;
  163. mDynamicCubemap = NULL;
  164. mLastUpdateTime = 0;
  165. mAutoGenerated = false;
  166. mShowDust = false;
  167. mShowFootprints = true;
  168. dMemset( mEffectColor, 0, sizeof( mEffectColor ) );
  169. mFootstepSoundId = -1; mImpactSoundId = -1;
  170. mFootstepSoundCustom = 0; mImpactSoundCustom = 0;
  171. mFriction = 0.0;
  172. mDirectSoundOcclusion = 1.f;
  173. mReverbSoundOcclusion = 1.0;
  174. }
  175. void Material::initPersistFields()
  176. {
  177. addField("mapTo", TypeRealString, Offset(mMapTo, Material),
  178. "Used to map this material to the material name used by TSShape." );
  179. addArray( "Stages", MAX_STAGES );
  180. addField("diffuseColor", TypeColorF, Offset(mDiffuse, Material), MAX_STAGES,
  181. "This color is multiplied against the diffuse texture color. If no diffuse texture "
  182. "is present this is the material color." );
  183. addField("diffuseMap", TypeImageFilename, Offset(mDiffuseMapFilename, Material), MAX_STAGES,
  184. "The diffuse color texture map." );
  185. addField("diffuseMapSRGB", TypeBool, Offset(mDiffuseMapSRGB, Material), MAX_STAGES,
  186. "Enable sRGB for the diffuse color texture map.");
  187. addField("overlayMap", TypeImageFilename, Offset(mOverlayMapFilename, Material), MAX_STAGES,
  188. "A secondary diffuse color texture map which will use the second texcoord of a mesh." );
  189. addField("lightMap", TypeImageFilename, Offset(mLightMapFilename, Material), MAX_STAGES,
  190. "The lightmap texture used with pureLight." );
  191. addField("toneMap", TypeImageFilename, Offset(mToneMapFilename, Material), MAX_STAGES,
  192. "The tonemap texture used with pureLight.");
  193. addField("detailMap", TypeImageFilename, Offset(mDetailMapFilename, Material), MAX_STAGES,
  194. "A typically greyscale detail texture additively blended into the material." );
  195. addField("detailScale", TypePoint2F, Offset(mDetailScale, Material), MAX_STAGES,
  196. "The scale factor for the detail map." );
  197. addField( "normalMap", TypeImageFilename, Offset(mNormalMapFilename, Material), MAX_STAGES,
  198. "The normal map texture. You can use the DXTnm format only when per-pixel "
  199. "specular highlights are disabled, or a specular map is in use." );
  200. addField( "detailNormalMap", TypeImageFilename, Offset(mDetailNormalMapFilename, Material), MAX_STAGES,
  201. "A second normal map texture applied at the detail scale. You can use the DXTnm "
  202. "format only when per-pixel specular highlights are disabled." );
  203. addField( "detailNormalMapStrength", TypeF32, Offset(mDetailNormalMapStrength, Material), MAX_STAGES,
  204. "Used to scale the strength of the detail normal map when blended with the base normal map." );
  205. addField("smoothness", TypeF32, Offset(mSmoothness, Material), MAX_STAGES,
  206. "The degree of smoothness when not using a specularMap." );
  207. addField("metalness", TypeF32, Offset(mMetalness, Material), MAX_STAGES,
  208. "The degree of Metalness when not using a specularMap." );
  209. addProtectedField( "accuEnabled", TYPEID< bool >(), Offset( mAccuEnabled, Material ),
  210. &_setAccuEnabled, &defaultProtectedGetFn, MAX_STAGES, "Accumulation texture." );
  211. addField("accuScale", TypeF32, Offset(mAccuScale, Material), MAX_STAGES,
  212. "The scale that is applied to the accu map texture. You can use this to fit the texture to smaller or larger objects.");
  213. addField("accuDirection", TypeF32, Offset(mAccuDirection, Material), MAX_STAGES,
  214. "The direction of the accumulation. Chose whether you want the accu map to go from top to bottom (ie. snow) or upwards (ie. mold).");
  215. addField("accuStrength", TypeF32, Offset(mAccuStrength, Material), MAX_STAGES,
  216. "The strength of the accu map. This changes the transparency of the accu map texture. Make it subtle or add more contrast.");
  217. addField("accuCoverage", TypeF32, Offset(mAccuCoverage, Material), MAX_STAGES,
  218. "The coverage ratio of the accu map texture. Use this to make the entire shape pick up some of the accu map texture or none at all.");
  219. addField("accuSpecular", TypeF32, Offset(mAccuSpecular, Material), MAX_STAGES,
  220. "Changes specularity to this value where the accumulated material is present.");
  221. addField("isSRGb", TypeBool, Offset(mIsSRGb, Material), MAX_STAGES,
  222. "Substance Designer Workaround.");
  223. addField("invertSmoothness", TypeBool, Offset(mInvertSmoothness, Material), MAX_STAGES,
  224. "Treat Smoothness as Roughness");
  225. addField( "specularMap", TypeImageFilename, Offset(mSpecularMapFilename, Material), MAX_STAGES,
  226. "Prepacked specular map texture. The RGB channels of this texture provide per-pixel reference values for: "
  227. "smoothness (R), Ambient Occlusion (G), and metalness(B)");
  228. addField("roughMap", TypeImageFilename, Offset(mRoughMapFilename, Material), MAX_STAGES,
  229. "smoothness map. will be packed into the R channel of a packed 'specular' map");
  230. addField("smoothnessChan", TypeF32, Offset(mSmoothnessChan, Material), MAX_STAGES,
  231. "The input channel smoothness maps use.");
  232. addField("aoMap", TypeImageFilename, Offset(mAOMapFilename, Material), MAX_STAGES,
  233. "Ambient Occlusion map. will be packed into the G channel of a packed 'specular' map");
  234. addField("AOChan", TypeF32, Offset(mAOChan, Material), MAX_STAGES,
  235. "The input channel AO maps use.");
  236. addField("metalMap", TypeImageFilename, Offset(mMetalMapFilename, Material), MAX_STAGES,
  237. "Metalness map. will be packed into the B channel of a packed 'specular' map");
  238. addField("metalChan", TypeF32, Offset(mMetalChan, Material), MAX_STAGES,
  239. "The input channel metalness maps use.");
  240. addField( "parallaxScale", TypeF32, Offset(mParallaxScale, Material), MAX_STAGES,
  241. "Enables parallax mapping and defines the scale factor for the parallax effect. Typically "
  242. "this value is less than 0.4 else the effect breaks down." );
  243. addField( "useAnisotropic", TypeBool, Offset(mUseAnisotropic, Material), MAX_STAGES,
  244. "Use anisotropic filtering for the textures of this stage." );
  245. addField("vertLit", TypeBool, Offset(mVertLit, Material), MAX_STAGES,
  246. "If true the vertex color is used for lighting." );
  247. addField( "vertColor", TypeBool, Offset( mVertColor, Material ), MAX_STAGES,
  248. "If enabled, vertex colors are premultiplied with diffuse colors." );
  249. addField("minnaertConstant", TypeF32, Offset(mMinnaertConstant, Material), MAX_STAGES,
  250. "The Minnaert shading constant value. Must be greater than 0 to enable the effect." );
  251. addField("subSurface", TypeBool, Offset(mSubSurface, Material), MAX_STAGES,
  252. "Enables the subsurface scattering approximation." );
  253. addField("subSurfaceColor", TypeColorF, Offset(mSubSurfaceColor, Material), MAX_STAGES,
  254. "The color used for the subsurface scattering approximation." );
  255. addField("subSurfaceRolloff", TypeF32, Offset(mSubSurfaceRolloff, Material), MAX_STAGES,
  256. "The 0 to 1 rolloff factor used in the subsurface scattering approximation." );
  257. addField("glow", TypeBool, Offset(mGlow, Material), MAX_STAGES,
  258. "Enables rendering this material to the glow buffer." );
  259. addField("emissive", TypeBool, Offset(mEmissive, Material), MAX_STAGES,
  260. "Enables emissive lighting for the material." );
  261. addField("doubleSided", TypeBool, Offset(mDoubleSided, Material),
  262. "Disables backface culling casing surfaces to be double sided. "
  263. "Note that the lighting on the backside will be a mirror of the front "
  264. "side of the surface." );
  265. addField("animFlags", TYPEID< AnimType >(), Offset(mAnimFlags, Material), MAX_STAGES,
  266. "The types of animation to play on this material." );
  267. addField("scrollDir", TypePoint2F, Offset(mScrollDir, Material), MAX_STAGES,
  268. "The scroll direction in UV space when scroll animation is enabled." );
  269. addField("scrollSpeed", TypeF32, Offset(mScrollSpeed, Material), MAX_STAGES,
  270. "The speed to scroll the texture in UVs per second when scroll animation is enabled." );
  271. addField("rotSpeed", TypeF32, Offset(mRotSpeed, Material), MAX_STAGES,
  272. "The speed to rotate the texture in degrees per second when rotation animation is enabled." );
  273. addField("rotPivotOffset", TypePoint2F, Offset(mRotPivotOffset, Material), MAX_STAGES,
  274. "The piviot position in UV coordinates to center the rotation animation." );
  275. addField("waveType", TYPEID< WaveType >(), Offset(mWaveType, Material), MAX_STAGES,
  276. "The type of wave animation to perform when wave animation is enabled." );
  277. addField("waveFreq", TypeF32, Offset(mWaveFreq, Material), MAX_STAGES,
  278. "The wave frequency when wave animation is enabled." );
  279. addField("waveAmp", TypeF32, Offset(mWaveAmp, Material), MAX_STAGES,
  280. "The wave amplitude when wave animation is enabled." );
  281. addField("sequenceFramePerSec", TypeF32, Offset(mSeqFramePerSec, Material), MAX_STAGES,
  282. "The number of frames per second for frame based sequence animations if greater than zero." );
  283. addField("sequenceSegmentSize", TypeF32, Offset(mSeqSegSize, Material), MAX_STAGES,
  284. "The size of each frame in UV units for sequence animations." );
  285. // Texture atlasing
  286. addField("cellIndex", TypePoint2I, Offset(mCellIndex, Material), MAX_STAGES,
  287. "@internal" );
  288. addField("cellLayout", TypePoint2I, Offset(mCellLayout, Material), MAX_STAGES,
  289. "@internal");
  290. addField("cellSize", TypeS32, Offset(mCellSize, Material), MAX_STAGES,
  291. "@internal");
  292. addField("bumpAtlas", TypeBool, Offset(mNormalMapAtlas, Material), MAX_STAGES,
  293. "@internal");
  294. // For backwards compatibility.
  295. //
  296. // They point at the new 'map' fields, but reads always return
  297. // an empty string and writes only apply if the value is not empty.
  298. //
  299. addProtectedField("baseTex", TypeImageFilename, Offset(mDiffuseMapFilename, Material),
  300. defaultProtectedSetNotEmptyFn, emptyStringProtectedGetFn, MAX_STAGES,
  301. "For backwards compatibility.\n@see diffuseMap\n" );
  302. addProtectedField("detailTex", TypeImageFilename, Offset(mDetailMapFilename, Material),
  303. defaultProtectedSetNotEmptyFn, emptyStringProtectedGetFn, MAX_STAGES,
  304. "For backwards compatibility.\n@see detailMap\n");
  305. addProtectedField("overlayTex", TypeImageFilename, Offset(mOverlayMapFilename, Material),
  306. defaultProtectedSetNotEmptyFn, emptyStringProtectedGetFn, MAX_STAGES,
  307. "For backwards compatibility.\n@see overlayMap\n");
  308. addProtectedField("bumpTex", TypeImageFilename, Offset(mNormalMapFilename, Material),
  309. defaultProtectedSetNotEmptyFn, emptyStringProtectedGetFn, MAX_STAGES,
  310. "For backwards compatibility.\n@see normalMap\n");
  311. addProtectedField("colorMultiply", TypeColorF, Offset(mDiffuse, Material),
  312. defaultProtectedSetNotEmptyFn, emptyStringProtectedGetFn, MAX_STAGES,
  313. "For backwards compatibility.\n@see diffuseColor\n");
  314. endArray( "Stages" );
  315. addField( "castShadows", TypeBool, Offset(mCastShadows, Material),
  316. "If set to false the lighting system will not cast shadows from this material." );
  317. addField( "castDynamicShadows", TypeBool, Offset(mCastDynamicShadows, Material),
  318. "If set to false the lighting system will not cast dynamic shadows from this material." );
  319. addField("planarReflection", TypeBool, Offset(mPlanarReflection, Material), "@internal" );
  320. addField("translucent", TypeBool, Offset(mTranslucent, Material),
  321. "If true this material is translucent blended." );
  322. addField("translucentBlendOp", TYPEID< BlendOp >(), Offset(mTranslucentBlendOp, Material),
  323. "The type of blend operation to use when the material is translucent." );
  324. addField("translucentZWrite", TypeBool, Offset(mTranslucentZWrite, Material),
  325. "If enabled and the material is translucent it will write into the depth buffer." );
  326. addField("alphaTest", TypeBool, Offset(mAlphaTest, Material),
  327. "Enables alpha test when rendering the material.\n@see alphaRef\n" );
  328. addField("alphaRef", TypeS32, Offset(mAlphaRef, Material),
  329. "The alpha reference value for alpha testing. Must be between 0 to 255.\n@see alphaTest\n" );
  330. addField("cubemap", TypeRealString, Offset(mCubemapName, Material),
  331. "The name of a CubemapData for environment mapping." );
  332. addField("dynamicCubemap", TypeBool, Offset(mDynamicCubemap, Material),
  333. "Enables the material to use the dynamic cubemap from the ShapeBase object its applied to." );
  334. addGroup( "Behavioral" );
  335. addField( "showFootprints", TypeBool, Offset( mShowFootprints, Material ),
  336. "Whether to show player footprint decals on this material.\n\n"
  337. "@see PlayerData::decalData" );
  338. addField( "showDust", TypeBool, Offset( mShowDust, Material ),
  339. "Whether to emit dust particles from a shape moving over the material. This is, for example, used by "
  340. "vehicles or players to decide whether to show dust trails." );
  341. addField( "effectColor", TypeColorF, Offset( mEffectColor, Material ), NUM_EFFECT_COLOR_STAGES,
  342. "If #showDust is true, this is the set of colors to use for the ParticleData of the dust "
  343. "emitter.\n\n"
  344. "@see ParticleData::colors" );
  345. addField( "footstepSoundId", TypeS32, Offset( mFootstepSoundId, Material ),
  346. "What sound to play from the PlayerData sound list when the player walks over the material. -1 (default) to not play any sound.\n"
  347. "\n"
  348. "The IDs are:\n\n"
  349. "- 0: PlayerData::FootSoftSound\n"
  350. "- 1: PlayerData::FootHardSound\n"
  351. "- 2: PlayerData::FootMetalSound\n"
  352. "- 3: PlayerData::FootSnowSound\n"
  353. "- 4: PlayerData::FootShallowSound\n"
  354. "- 5: PlayerData::FootWadingSound\n"
  355. "- 6: PlayerData::FootUnderwaterSound\n"
  356. "- 7: PlayerData::FootBubblesSound\n"
  357. "- 8: PlayerData::movingBubblesSound\n"
  358. "- 9: PlayerData::waterBreathSound\n"
  359. "- 10: PlayerData::impactSoftSound\n"
  360. "- 11: PlayerData::impactHardSound\n"
  361. "- 12: PlayerData::impactMetalSound\n"
  362. "- 13: PlayerData::impactSnowSound\n"
  363. "- 14: PlayerData::impactWaterEasy\n"
  364. "- 15: PlayerData::impactWaterMedium\n"
  365. "- 16: PlayerData::impactWaterHard\n"
  366. "- 17: PlayerData::exitingWater\n" );
  367. addField( "customFootstepSound", TypeSFXTrackName, Offset( mFootstepSoundCustom, Material ),
  368. "The sound to play when the player walks over the material. If this is set, it overrides #footstepSoundId. This field is "
  369. "useful for directly assigning custom footstep sounds to materials without having to rely on the PlayerData sound assignment.\n\n"
  370. "@warn Be aware that materials are client-side objects. This means that the SFXTracks assigned to materials must be client-side, too." );
  371. addField( "impactSoundId", TypeS32, Offset( mImpactSoundId, Material ),
  372. "What sound to play from the PlayerData sound list when the player impacts on the surface with a velocity equal or greater "
  373. "than PlayerData::groundImpactMinSpeed.\n\n"
  374. "For a list of IDs, see #footstepSoundId" );
  375. addField( "customImpactSound", TypeSFXTrackName, Offset( mImpactSoundCustom, Material ),
  376. "The sound to play when the player impacts on the surface with a velocity equal or greater than PlayerData::groundImpactMinSpeed. "
  377. "If this is set, it overrides #impactSoundId. This field is useful for directly assigning custom impact sounds to materials "
  378. "without having to rely on the PlayerData sound assignment.\n\n"
  379. "@warn Be aware that materials are client-side objects. This means that the SFXTracks assigned to materials must be client-side, too." );
  380. //Deactivate these for the moment as they are not used.
  381. #if 0
  382. addField( "friction", TypeF32, Offset( mFriction, Material ) );
  383. addField( "directSoundOcclusion", TypeF32, Offset( mDirectSoundOcclusion, Material ) );
  384. addField( "reverbSoundOcclusion", TypeF32, Offset( mReverbSoundOcclusion, Material ) );
  385. #endif
  386. endGroup( "Behavioral" );
  387. Parent::initPersistFields();
  388. }
  389. bool Material::writeField( StringTableEntry fieldname, const char *value )
  390. {
  391. // Never allow the old field names to be written.
  392. if ( fieldname == StringTable->insert("baseTex") ||
  393. fieldname == StringTable->insert("detailTex") ||
  394. fieldname == StringTable->insert("overlayTex") ||
  395. fieldname == StringTable->insert("bumpTex") ||
  396. fieldname == StringTable->insert("envTex") ||
  397. fieldname == StringTable->insert("colorMultiply") )
  398. return false;
  399. return Parent::writeField( fieldname, value );
  400. }
  401. bool Material::onAdd()
  402. {
  403. if (Parent::onAdd() == false)
  404. return false;
  405. mCubemapData = dynamic_cast<CubemapData*>(Sim::findObject( mCubemapName ) );
  406. if( mTranslucentBlendOp >= NumBlendTypes || mTranslucentBlendOp < 0 )
  407. {
  408. Con::errorf( "Invalid blend op in material: %s", getName() );
  409. mTranslucentBlendOp = LerpAlpha;
  410. }
  411. SimSet *matSet = MATMGR->getMaterialSet();
  412. if( matSet )
  413. matSet->addObject( (SimObject*)this );
  414. // save the current script path for texture lookup later
  415. const String scriptFile = Con::getVariable("$Con::File"); // current script file - local materials.cs
  416. String::SizeType slash = scriptFile.find( '/', scriptFile.length(), String::Right );
  417. if ( slash != String::NPos )
  418. mPath = scriptFile.substr( 0, slash + 1 );
  419. _mapMaterial();
  420. return true;
  421. }
  422. void Material::onRemove()
  423. {
  424. smNormalizeCube = NULL;
  425. Parent::onRemove();
  426. }
  427. void Material::inspectPostApply()
  428. {
  429. Parent::inspectPostApply();
  430. // Reload the material instances which
  431. // use this material.
  432. if ( isProperlyAdded() )
  433. reload();
  434. }
  435. bool Material::isLightmapped() const
  436. {
  437. bool ret = false;
  438. for( U32 i=0; i<MAX_STAGES; i++ )
  439. ret |= mLightMapFilename[i].isNotEmpty() || mToneMapFilename[i].isNotEmpty() || mVertLit[i];
  440. return ret;
  441. }
  442. void Material::updateTimeBasedParams()
  443. {
  444. U32 lastTime = MATMGR->getLastUpdateTime();
  445. F32 dt = MATMGR->getDeltaTime();
  446. if (mLastUpdateTime != lastTime)
  447. {
  448. for (U32 i = 0; i < MAX_STAGES; i++)
  449. {
  450. mScrollOffset[i] += mScrollDir[i] * mScrollSpeed[i] * dt;
  451. mRotPos[i] += mRotSpeed[i] * dt;
  452. mWavePos[i] += mWaveFreq[i] * dt;
  453. }
  454. mLastUpdateTime = lastTime;
  455. }
  456. }
  457. void Material::_mapMaterial()
  458. {
  459. if( String(getName()).isEmpty() )
  460. {
  461. Con::warnf( "[Material::mapMaterial] - Cannot map unnamed Material" );
  462. return;
  463. }
  464. // If mapTo not defined in script, try to use the base texture name instead
  465. if( mMapTo.isEmpty() )
  466. {
  467. if ( mDiffuseMapFilename[0].isEmpty() )
  468. return;
  469. else
  470. {
  471. // extract filename from base texture
  472. if ( mDiffuseMapFilename[0].isNotEmpty() )
  473. {
  474. U32 slashPos = mDiffuseMapFilename[0].find('/',0,String::Right);
  475. if (slashPos == String::NPos)
  476. // no '/' character, must be no path, just the filename
  477. mMapTo = mDiffuseMapFilename[0];
  478. else
  479. // use everything after the last slash
  480. mMapTo = mDiffuseMapFilename[0].substr(slashPos+1, mDiffuseMapFilename[0].length() - slashPos - 1);
  481. }
  482. }
  483. }
  484. // add mapping
  485. MATMGR->mapMaterial(mMapTo,getName());
  486. }
  487. BaseMatInstance* Material::createMatInstance()
  488. {
  489. return new MatInstance(*this);
  490. }
  491. void Material::flush()
  492. {
  493. MATMGR->flushInstance( this );
  494. }
  495. void Material::reload()
  496. {
  497. MATMGR->reInitInstance( this );
  498. }
  499. void Material::StageData::getFeatureSet( FeatureSet *outFeatures ) const
  500. {
  501. TextureTable::ConstIterator iter = mTextures.begin();
  502. for ( ; iter != mTextures.end(); iter++ )
  503. {
  504. if ( iter->value.isValid() )
  505. outFeatures->addFeature( *iter->key );
  506. }
  507. }
  508. DefineEngineMethod( Material, flush, void, (),,
  509. "Flushes all material instances that use this material." )
  510. {
  511. object->flush();
  512. }
  513. DefineEngineMethod( Material, reload, void, (),,
  514. "Reloads all material instances that use this material." )
  515. {
  516. object->reload();
  517. }
  518. DefineEngineMethod( Material, dumpInstances, void, (),,
  519. "Dumps a formatted list of the currently allocated material instances for this material to the console." )
  520. {
  521. MATMGR->dumpMaterialInstances( object );
  522. }
  523. DefineEngineMethod( Material, getAnimFlags, const char*, (U32 id), , "" )
  524. {
  525. char * animFlags = Con::getReturnBuffer(512);
  526. if(object->mAnimFlags[ id ] & Material::Scroll)
  527. {
  528. if(dStrcmp( animFlags, "" ) == 0)
  529. dStrcpy( animFlags, "$Scroll", 512 );
  530. }
  531. if(object->mAnimFlags[ id ] & Material::Rotate)
  532. {
  533. if(dStrcmp( animFlags, "" ) == 0)
  534. dStrcpy( animFlags, "$Rotate", 512 );
  535. else
  536. dStrcat( animFlags, " | $Rotate", 512);
  537. }
  538. if(object->mAnimFlags[ id ] & Material::Wave)
  539. {
  540. if(dStrcmp( animFlags, "" ) == 0)
  541. dStrcpy( animFlags, "$Wave", 512 );
  542. else
  543. dStrcat( animFlags, " | $Wave", 512);
  544. }
  545. if(object->mAnimFlags[ id ] & Material::Scale)
  546. {
  547. if(dStrcmp( animFlags, "" ) == 0)
  548. dStrcpy( animFlags, "$Scale", 512 );
  549. else
  550. dStrcat( animFlags, " | $Scale", 512);
  551. }
  552. if(object->mAnimFlags[ id ] & Material::Sequence)
  553. {
  554. if(dStrcmp( animFlags, "" ) == 0)
  555. dStrcpy( animFlags, "$Sequence", 512 );
  556. else
  557. dStrcat( animFlags, " | $Sequence", 512);
  558. }
  559. return animFlags;
  560. }
  561. DefineEngineMethod(Material, getFilename, const char*, (),, "Get filename of material")
  562. {
  563. SimObject *material = static_cast<SimObject *>(object);
  564. return material->getFilename();
  565. }
  566. DefineEngineMethod( Material, isAutoGenerated, bool, (),,
  567. "Returns true if this Material was automatically generated by MaterialList::mapMaterials()" )
  568. {
  569. return object->isAutoGenerated();
  570. }
  571. DefineEngineMethod( Material, setAutoGenerated, void, (bool isAutoGenerated), ,
  572. "setAutoGenerated(bool isAutoGenerated): Set whether or not the Material is autogenerated." )
  573. {
  574. object->setAutoGenerated(isAutoGenerated);
  575. }
  576. DefineEngineMethod(Material, getAutogeneratedFile, const char*, (), , "Get filename of autogenerated shader file")
  577. {
  578. SimObject *material = static_cast<SimObject *>(object);
  579. return material->getFilename();
  580. }
  581. // Accumulation
  582. bool Material::_setAccuEnabled( void *object, const char *index, const char *data )
  583. {
  584. Material* mat = reinterpret_cast< Material* >( object );
  585. if ( index )
  586. {
  587. U32 i = dAtoui(index);
  588. mat->mAccuEnabled[i] = dAtob(data);
  589. AccumulationVolume::refreshVolumes();
  590. }
  591. return true;
  592. }