Differential D11620 Diff 38451 manual/modeling/geometry_nodes/geometry/raycast.rst

Changeset View

Standalone View

manual/modeling/geometry_nodes/geometry/raycast.rst

This file was added.

Property	Old Value	New Value
svn:eol-style	null	native \ No newline at end of property

				.. index:: Geometry Nodes; Raycast
				.. _bpy.types.GeometryNodeRaycast:

				*******
				Raycast
				*******

				.. figure:: /images/modeling_geometry-nodes_geometry_raycast_node.png
				:align: center

				Raycast node.

				The Raycast node intersects rays from one geometry onto another.
				It computes hit points on the target mesh and returns normals, distances
				and any surface attribute specified by the user.

				A ray starts on each point of the input Geometry. Rays continue
				in the Ray Direction until they either hit the Target Geometry
				or reach the Ray Length limit. If the target is hit, the value of the Is Hit
				attribute in the output mesh will be true. Hit Position, Hit Normal and
				Hit Distance are the properties of the target mesh at the intersection point.
				In addition, a Target Attribute can be specified that is interpolated
				at the hit point and the result stored in Hit Attribute.


				Inputs
				======

				Geometry
				Rays are create at the geometry points.
				HooglyBooglyUnsubmitted Done Inline Actions typo: `create` -> `created` HooglyBoogly: typo: `create` -> `created`

				Target Geometry
				Geometry that rays are tested against.

				Ray Direction
				Direction of each ray from the starting position.

				Ray Length
				Maximum distance a ray can travel before being considered "no hit".

				Target Attribute
				An optional attribute of the Target Geometry that will be interpolated and output in Hit Attribute.
				HooglyBooglyUnsubmitted Not Done Inline Actions `An optional attribute` -> `An optional output attribute`. Same for the others. Might as well make it clear in the documentation if we can't in the UI ;) HooglyBoogly: `An optional attribute ` -> `An optional output attribute`. Same for the others. Might as well…
				lukastoenneAuthorUnsubmitted Done Inline Actions `An optional attribute` -> `An optional output attribute`. Same for the others. Might as well make it clear in the documentation if we can't in the UI ;) This one is an input attribute actually. It's the attribute that gets interpolated, the results are stored in "Hit Attribute". I've tried make this a bit more clear now. All the output attributes are described as such now. lukastoenne: > `An optional attribute ` -> `An optional output attribute`. Same for the others. > > Might…
				HooglyBooglyUnsubmitted Not Done Inline Actions Oops, I managed to put that comment on the one input attribute name! Thanks. HooglyBoogly: Oops, I managed to put that comment on the one input attribute name! Thanks.

				Is Hit
				Boolean output attribute that is true for each ray which has hit the Target Geometry.

				Hit Position
				Intersection point with the target mesh for each hit.

				Hit Normal
				Normal of the target mesh surface for each hit.

				Hit Distance
				Distance from the ray origin to the hit point for each hit.

				Hit Attribute
				Interpolated values of the Target Attribute at the hit positions.


				Properties
				==========

				Ray Direction
				:Attribute: The input is a text field that expects an attribute name.
				:Vector: The input is a vector of three float numbers.

				Ray Length
				:Attribute: The input is a text field that expects an attribute name.
				:Float: The input is a number field.

				Mapping
				How attributes of the target mesh are mapped to attributes of rays.
				HooglyBooglyUnsubmitted Done Inline Actions `to the attribute values on the result geometry` HooglyBoogly: `to the attribute values on the result geometry`

				Interpolated
				Vertex and corner attributes are interpolated with a bilinear function.

				Nearest
				Choses the attribute value of the closest vertex or face corner without interpolating.
				HooglyBooglyUnsubmitted Done Inline Actions typo: `choses` -> `chooses` HooglyBoogly: typo: `choses` -> `chooses`


				Outputs
				=======

				Geometry
				Geometry that contains output attributes for each ray.