Merge pull request #38 from AxiomeCG/feature/37-warning-message-verbose

Add a verbose parameter to disable the warning messages in the console

.gitignore

@@ -102,3 +102,6 @@ dist
 
 # TernJS port file
 .tern-port
+
+# Webstorm project config folder
+.idea

examples/debug/src/App.tsx

@@ -31,7 +31,7 @@ export default function App() {
  <Canvas shadows>
  <OrbitControls makeDefault />
  <PerspectiveCamera position={[-5, 5, 5]} makeDefault />
- <Environment preset="warehouse" />
+ <Environment files="https://dl.polyhaven.org/file/ph-assets/HDRIs/hdr/1k/empty_warehouse_01_1k.hdr" />
  <Thing />
  {/* <CacheTest /> */}
 

examples/instances/src/App.js

@@ -115,7 +115,7 @@ function App() {
  }}
  >
  <Suspense>
- <Environment preset="sunset" />
+ <Environment files="https://dl.polyhaven.org/file/ph-assets/HDRIs/hdr/1k/venice_sunset_1k.hdr" />
  <Thing />
  </Suspense>
 

examples/points/src/App.js

@@ -95,7 +95,7 @@ function App() {
  }}
  >
  <Suspense>
- <Environment preset="sunset" />
+ <Environment files="https://dl.polyhaven.org/file/ph-assets/HDRIs/hdr/1k/venice_sunset_1k.hdr" />
  <Thing />
  </Suspense>
 

examples/waves/src/App.tsx

@@ -60,7 +60,7 @@ export default function App() {
  <color attach="background" args={['#ebebeb']} />
  <Suspense fallback={null}>
  {['MeshPhysicalMaterial', 'MeshStanderedMaterial'].includes(Base.name) ? (
- <Environment preset="sunset" />
+ <Environment files="https://dl.polyhaven.org/file/ph-assets/HDRIs/hdr/1k/venice_sunset_1k.hdr" />
  ) : (
  <Lights />
  )}

package/README.md

@@ -45,6 +45,7 @@ function Box() {
  baseMaterial: THREE.MeshPhysicalMaterial,
  vertexShader: /* glsl */ ` ... `,
  fragmentShader: /* glsl */ ` ... `,
+ silent: true, // Disables the default warning if true
  uniforms: {
  uTime: {
  value: 0,
@@ -83,6 +84,8 @@ function Cube() {
  baseMaterial={THREE.MeshPhysicalMaterial}
  vertexShader={/* glsl */ ` ... `}
  fragmentShader={/* glsl */ ` ... `}
+ {/*silent parameter to true disables the default warning if needed*/}
+ silent
  uniforms={{
  uTime: {
  value: 0,

package/src/keywords.ts

@@ -11,5 +11,5 @@ export default {
  metalness: 'csm_Metalness', // Metalness
  emissive: 'csm_Emissive', // Emissive
  ao: 'csm_AO', // AO
- bump: 'csm_Bump' // Bump
+ bump: 'csm_Bump', // Bump
 }

package/src/types.ts

@@ -15,6 +15,7 @@ export type iCSMParams<T extends MaterialConstructor> = {
  fragmentShader?: string
  cacheKey?: () => string
  patchMap?: iCSMPatchMap
+ silent?: boolean
  uniforms?: { [key: string]: THREE.IUniform<any> }
 } & (MaterialParams<T> extends undefined ? {} : MaterialParams<T>)
 
@@ -30,6 +31,7 @@ export interface iCSMInternals<T extends MaterialConstructor> {
  type: string
  isAlreadyExtended: boolean
  cacheHash: string
+ silent?: boolean
 }
 
 export type Uniform = { [key: string]: THREE.IUniform<any> }

package/src/vanilla.ts

@@ -47,7 +47,7 @@ function isConstructor<T extends MaterialConstructor>(f: T | InstanceType<T>): f
  return true
 }
 
-function copyObject(target: any, source: any) {
+function copyObject(target: any, source: any, silent = false) {
  Object.assign(target, source)
 
  const proto = Object.getPrototypeOf(source)
@@ -63,7 +63,7 @@ function copyObject(target: any, source: any) {
  .forEach((val) => {
  // If function exists on target, rename it with "base_" prefix
  if (typeof target[val[0]] === 'function') {
- console.warn(`Function ${val[0]} already exists on CSM, renaming to base_${val[0]}`)
+ if (!silent) console.warn(`Function ${val[0]} already exists on CSM, renaming to base_${val[0]}`)
  const baseName = `base_${val[0]}`
  target[baseName] = val[1].value.bind(target)
  return
@@ -105,6 +105,7 @@ export default class CustomShaderMaterial<
  uniforms,
  patchMap,
  cacheKey,
+ silent,
  ...opts
  }: iCSMParams<T>) {
  let base: THREE.Material
@@ -127,7 +128,7 @@ export default class CustomShaderMaterial<
  // Copy all properties from base material onto this material
  // Rename any functions that already exist on this material with "base_" prefix
  super()
- copyObject(this, base)
+ copyObject(this, base, silent)
 
  // Set up private internals
  this.__csm = {
@@ -140,6 +141,7 @@ export default class CustomShaderMaterial<
  type: base.type,
  isAlreadyExtended: !isFunctionEmpty(base.onBeforeCompile),
  cacheHash: ``,
+ silent: silent,
  }
 
  this.uniforms = {
@@ -196,6 +198,7 @@ export default class CustomShaderMaterial<
  fragmentShader: this.__csm.fragmentShader,
  vertexShader: this.__csm.vertexShader,
  uniforms: this.uniforms,
+ silent: this.__csm.silent,
  patchMap: this.__csm.patchMap,
  cacheKey: this.__csm.cacheKey,
  }