<Render/>
<Render/> コンポーネントは <Entity/> が 3D Asset またはプリミティブ形状を表示できるようにします。<Render/> コンポーネントを <Entity/> に追加すると、Entity に RenderComponent が追加されます。type Prop でレンダリングするプリミティブ形状を選択できます。
- Demo
- Code
render-box.jsx
import { Entity } from '@playcanvas/react'
import { Render } from '@playcanvas/react/components'
import { useState } from 'react';
export const RenderBox = () => {
const [shape, setShape] = useState('box');
const onSphereClick = () => setShape('sphere');
const onBoxClick = () => setShape('box');
return (<>
<Entity position={[0, 0, 0]}>
<Render type={shape} />
</Entity>
<div className="overlay">
<button data-selected={shape === 'sphere'} onClick={onSphereClick}>Sphere</button>
<button data-selected={shape === 'box'} onClick={onBoxClick}>Box</button>
</div>
</>
)
}
Asset のレンダリング
URL からロードした 3D モデルをレンダリングするには、asset タイプを使用して asset Prop に直接 Asset を渡します。Asset のロードについての詳細は Asset ロードガイド を参照してください。
import { Render } from '@playcanvas/react/components'
import { useModel } from '@playcanvas/react/hooks'
const RenderModel = () => {
const { asset } = useModel('model.glb')
if (!asset) return null
return <Entity>
<Render type="asset" asset={asset} />
</Entity>
}
PlayCanvas ドキュメントの Render Component で詳細を確認できます。
プロパティ
| Name | Type | Default |
|---|---|---|
type | "asset" | "box" | "capsule" | "cone" | "cylinder" | "plane" | "sphere" | "torus"The type of primitive shape to render. | "box" |
asset? | Asset<string, unknown>The asset to render. | - |
children? | ReactNode | - |
isStatic? | booleanMark meshes as non-movable (optimization). | - |
renderStyle? | numberSets the render style of this component's MeshInstances. Can be:
- RENDERSTYLE_SOLID
- RENDERSTYLE_WIREFRAME
- RENDERSTYLE_POINTS
Defaults to RENDERSTYLE_SOLID.
Gets the render style of this component's MeshInstances. | - |
customAabb? | BoundingBox | nullSets the custom object space bounding box that is used for visibility culling of attached
mesh instances. This is an optimization, allowing an oversized bounding box to be specified
for skinned characters in order to avoid per frame bounding box computations based on bone
positions.
Gets the custom object space bounding box that is used for visibility culling of attached
mesh instances. | - |
meshInstances? | readonly MeshInstance[]Sets the array of meshInstances contained in the component.
Gets the array of meshInstances contained in the component. Use the setter to replace the
array; do not mutate the returned array. | - |
lightmapped? | booleanSets whether the component is affected by the runtime lightmapper. If true, the meshes will
be lightmapped after using lightmapper.bake().
Gets whether the component is affected by the runtime lightmapper. | - |
castShadows? | booleanSets whether attached meshes will cast shadows for lights that have shadow casting enabled.
Gets whether attached meshes will cast shadows for lights that have shadow casting enabled. | - |
shadowCascadeMask? | numberSets a bitmask that controls which shadow cascades the attached meshes contribute to when
rendered with a LIGHTTYPE_DIRECTIONAL light source. Combine the
SHADOW_CASCADE_0 .. SHADOW_CASCADE_3 flags to select individual cascades.
This is only effective when castShadows is enabled. Defaults to
SHADOW_CASCADE_ALL, which contributes to all available cascades.
Note that this filters the meshes per cascade at render time, it does not remove them from
the shadow casters of the Layer - use castShadows to disable shadow casting
completely.
Gets the bitmask that controls which shadow cascades the attached meshes contribute to. | - |
receiveShadows? | booleanSets whether shadows will be cast on attached meshes.
Gets whether shadows will be cast on attached meshes. | - |
clippingPlanes? | Plane[]Sets the planes that clip the attached meshes, in world space. The parts of the meshes behind
any of the planes - on the side opposite to the plane normal - are not rendered, which cuts
the meshes open along the planes. Use clipIntersection to clip only the parts behind
all of the planes instead. Up to 8 planes are supported, and any more are ignored. Defaults
to an empty array.
The planes are given to the mesh instances of the component together with
clipIntersection, also to ones it gets later, and replace their own, even when the
component has none. Planes assigned to a mesh instance directly last until the component next
gives it its clipping. The planes are copied, so changing a plane after the assignment has no
effect until the array is assigned again. To clip an entity together with its descendants,
such as an entity instantiated from a ContainerResource, assign the planes to all of
their render components. To clip everything a camera renders, see
CameraComponent#clippingPlanes instead. Meshes with clipping planes are excluded from
batching. See MeshInstance#clippingPlanes for more details.
Gets the planes that clip the attached meshes, in world space. These are copies of the
assigned planes, and changing them has no effect until the array is assigned again. | - |
clipIntersection? | booleanSets whether only the parts of the attached meshes behind all of the clippingPlanes
are clipped, instead of the parts behind any of them. With two planes this cuts a wedge out
of the meshes, and with three a corner, as a cutaway does. As with clippingPlanes,
the mesh instances are given the planes and the mode together. Defaults to false.
Gets whether only the parts of the attached meshes behind all of the clippingPlanes
are clipped. | - |
castShadowsLightmap? | booleanSets whether meshes instances will cast shadows when rendering lightmaps.
Gets whether meshes instances will cast shadows when rendering lightmaps. | - |
lightmapSizeMultiplier? | numberSets the lightmap resolution multiplier.
Gets the lightmap resolution multiplier. | - |
layers? | readonly number[]Sets the array of layer IDs (Layer#id ) to which the mesh instances belong. Don't
push, pop, splice or modify this array. If you want to change it, set a new one instead.
Gets the array of layer IDs (Layer#id ) to which the mesh instances belong. | - |
batchGroupId? | numberSets the batch group for the mesh instances in this component (see BatchGroup).
Default is -1 (no group).
Gets the batch group for the mesh instances in this component (see BatchGroup). | - |
material? | MaterialSets the material Material that will be used to render the component. The material
is ignored for renders of type 'asset' — which is the type every entity produced by
`instantiateRenderEntity` carries, so this setter has no effect on models loaded from a
container. For those, assign `material` on each entry of
RenderComponent#meshInstances instead.
Gets the material Material that will be used to render the component. | - |
materialAssets? | Asset<string, unknown>[] | number[]Sets the material assets that will be used to render the component. Each material
corresponds to the respective mesh instance.
Gets the material assets that will be used to render the component. | - |
rootBone? | Entity | nullSets the root bone entity (or entity guid) for the render component.
Gets the root bone entity for the render component. | - |
materialAsset? | any | - |
system? | ComponentSystemThe ComponentSystem used to create this Component. | - |
entity? | EntityThe Entity that this Component is attached to. | - |
enabled? | booleanSets the enabled state of the component.
Gets the enabled state of the component. | - |