Examples: Add a example for `OutlineEffect.js` module. about three.js HOT 7 CLOSED

Why MMD needs OutlineEffect

MMD uses "rendering backface of little bigger model" technique for drawing outline. Some MMD models expect this outline technique. For example sleeves of cloths have front face material (back-face culling) and the inside of them are expected to be rendered as black with the outline.

With outline

Without outline

This isn't doable with the edge-detection postprocessing approach. So I hope we can keep OutlineEffect.

OutlineEffect documents and API

I can't deny that the current OutlineEffect API is a bit too special in Three.js and specific to MMD. And honestly the implementation is a bit too way more complicated than it needs to be.

I'm thinking of reimplementing OutlineEffect for more Three.js API friendly. (I already have an idea but just lack of time.) We may document when we reimplement it.

from three.js.

The MMD examples use OutlineEffect.

from three.js.

The MMD examples use OutlineEffect.

Yes, I think users only see the source code to know how to use, even the useful userData.outlineParameters.visible

material.userData.outlineParameters = {
  visible: false,  //  User does not want to render it
};

TBH, I was try write toon material demo with OutlineEffect and I does not want to render something with OutlineEffect.
The current OutlineEffect examples does not use material.userData.outlineParameters.visible by now.

I searched outlineParameters keyword in code repository, only MMDLoader.js module is used.

from three.js.

Would adding a documentation page for OutlineEffect help?

from three.js.

Would adding a documentation page for OutlineEffect help?

I am not sure documentation page is useful.

In my opinion, a good example would be more intuitive and easier to learn and use on a basic level by now.

Only OutlineEffect.js without example by now...

from three.js.

OutlineEffect was specifically added for MMD / MeshToonMaterial. Compared to the other effects, I'm not sure a usage outside of this context makes sense (if you want to highlight something, there is OutlinePass).

@takahirox What do you think?

from three.js.

I'm thinking of reimplementing OutlineEffect for more Three.js API friendly. (I already have an idea but just lack of time.) We may document when we reimplement it.

Sounds good! In this case, it's okay to not add a documentation page or further examples for the existing OutlineEffect.

from three.js.