Skip to content

Docs:: Add documentation for ClippingGroup. #29833

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 12, 2024
Merged

Docs:: Add documentation for ClippingGroup. #29833

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
81d6b80
add docs
Nov 6, 2024
da5e503
move ClippingGroup.js
Nov 7, 2024
4be0834
Merge branch 'dev' into doc-clipping-group
Mugen87 Nov 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions docs/api/en/objects/ClippingGroup.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<base href="../../../" />
<script src="page.js"></script>
<link type="text/css" rel="stylesheet" href="page.css" />
</head>
<body>
[page:Group] &rarr;

<h1>[name]</h1>

<p class="desc">
A special version of the Group object that defines clipping planes for decendant objects.
ClippingGroups can be nested, with clipping planes accumulating by type: intersection or union.
</p>

<p>Note: ClippingGroup is only supported with WebGPURenderer.</p>

<h2>Constructor</h2>

<h3>[name]( )</h3>

<h2>Properties</h2>
<p>See the base [page:Group] class for common properties.</p>

<h3>[property:Boolean isClippingGroup]</h3>
<p>Read-only flag to check if a given object is of type [name].</p>

<h3>[property:Array clippingPlanes]</h3>
<p>
User-defined clipping planes specified as THREE.Plane objects in world
space. These planes apply to the objects that are children of this ClippingGroup.
Points in space whose signed distance to the plane is negative are clipped
(not rendered). See the [example:webgpu_clipping webgpu / clipping] example. Default is `[]`.
</p>

<h3>[property:Boolean enabled]</h3>
<p>Determines if the clipping planes defined by this object are applied. Default is `true`.</p>

<h3>[property:Boolean clipIntersection]</h3>
<p>
Changes the behavior of clipping planes so that only their intersection is
clipped, rather than their union. Default is `false`.
</p>

<h3>[property:Boolean clipShadows]</h3>
<p>
Defines whether to clip shadows according to the clipping planes specified
by this ClippingGroup. Default is `false`.
</p>

<h2>Methods</h2>
<p>See the base [page:Object3D] class for common methods.</p>

<h2>Source</h2>
<p>
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
</p>
</body>
</html>
1 change: 1 addition & 0 deletions docs/list.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,6 +267,7 @@
"Objects": {
"BatchedMesh": "api/en/objects/BatchedMesh",
"Bone": "api/en/objects/Bone",
"ClippingGroup": "api/en/objects/ClippingGroup",
"Group": "api/en/objects/Group",
"InstancedMesh": "api/en/objects/InstancedMesh",
"Line": "api/en/objects/Line",
Expand Down
1 change: 1 addition & 0 deletions src/Three.WebGPU.Nodes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,6 @@ export { default as IESSpotLight } from './lights/webgpu/IESSpotLight.js';
export { default as NodeLoader } from './loaders/nodes/NodeLoader.js';
export { default as NodeObjectLoader } from './loaders/nodes/NodeObjectLoader.js';
export { default as NodeMaterialLoader } from './loaders/nodes/NodeMaterialLoader.js';
export { ClippingGroup } from './objects/ClippingGroup.js';
export * from './nodes/Nodes.js';
export * from './nodes/TSL.js';
2 changes: 1 addition & 1 deletion src/Three.WebGPU.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ export * from './Three.core.js';

export * from './materials/nodes/NodeMaterials.js';
export { default as WebGPURenderer } from './renderers/webgpu/WebGPURenderer.js';
export { default as ClippingGroup } from './renderers/common/ClippingGroup.js';
export { default as Lighting } from './renderers/common/Lighting.js';
export { default as BundleGroup } from './renderers/common/BundleGroup.js';
export { default as QuadMesh } from './renderers/common/QuadMesh.js';
Expand All @@ -18,5 +17,6 @@ export { default as IESSpotLight } from './lights/webgpu/IESSpotLight.js';
export { default as NodeLoader } from './loaders/nodes/NodeLoader.js';
export { default as NodeObjectLoader } from './loaders/nodes/NodeObjectLoader.js';
export { default as NodeMaterialLoader } from './loaders/nodes/NodeMaterialLoader.js';
export { ClippingGroup } from './objects/ClippingGroup.js';
export * from './nodes/Nodes.js';
export * from './nodes/TSL.js';
4 changes: 2 additions & 2 deletions src/renderers/common/ClippingGroup.js → src/objects/ClippingGroup.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Group } from '../../objects/Group.js';
import { Group } from './Group.js';

class ClippingGroup extends Group {

Expand All @@ -16,4 +16,4 @@ class ClippingGroup extends Group {

}

export default ClippingGroup;
export { ClippingGroup };