CloudPoint

CloudPoint is a domain property of Points.

points.points = CloudPoint(self)

class CloudPoint(data_socket, selection=None)

property ID

ID attribute

Returns: Integer

getter: ID
setter: SetID

property as_cloud_points: Type cast to CloudPoint.

property as_control_points: Type cast to ControlPoint.

property as_corners: Type cast to Corner.

property as_edges: Type cast to Edge.

property as_faces: Type cast to Face.

property as_insts: Type cast to Instance.

property as_splines: Type cast to Spline.

property as_verts: Type cast to Vertex.

attribute(node)

Define an input node as attribute

Parameters: node (Node) – The node created by the domain
Returns: The node argument

Called when creating an input node in a property getter. Performs two actions:

Call the method Node.as_attribute() to tag the node as being an attribute. This will allow the Tree.check_attributes() to see if it is necessary to create a Capture Attribute for this field.

Set the nde property field_of to self in order to implement the transfer attribute mechanism.

property count

Count the number of items by return static.max + 1

Returns: Integer

getter: AttributeStatistic setter: read only

delete()

Delete points.

Node DeleteGeometry

Returns: self

cloud.points(...).delete()

duplicate(amount=None)

Duplicate domain.

Node DuplicateElements

Parameters: amount – Integer
Returns: duplicate index

get_named_attribute(name, data_type='FLOAT')

Get a named attribute

Called by methods set_named_xxx:

get_named_boolean()
get_named_integer()
get_named_float()
get_named_vector()
get_named_color()

get_named_boolean(name): Get named attribute of type BOOLEAN

get_named_color(name): Get named attribute of type FLOAT_COLOR

get_named_float(name): Get named attribute of type FLOAT

get_named_integer(name): Get named attribute of type INT

get_named_vector(name): Get named attribute of type FLOAT_VECTOR

property index

Index attribute

Returns: Integer

setter: Index
setter: Read only

index_transfer(attribute, index=None)

Transfer attribute with INDEX mapping

Parameters

attribute (Any) – The attribute to transfer
index (Integer) – Index

Returns

Same as attribute

instantiate(instance=None, pick_instance=None, instance_index=None, rotation=None, scale=None)

Put instances on points

Node InstanceOnPoints

Parameters

instance – Geometry
pick_instance – Boolean
instance_index – Integer
rotation – Vector
scale – Vector

Returns

Instances

Example

mesh.verts(…).instantiate(…) curve.points(…).instantiate(…) cloud.points(…).instantiate(…)

merge(distance=0.001)

Merge points by distance.

Node MergeByDistance

Parameters: distance – Float
Returns: self

cloud.points().merge()

nearest_face_transfer(attribute, source_position=None)

Transfer attribute with NEAREST_FACE_INTERPOLATED mapping

Parameters

attribute (Any) – The attribute to transfer
source_position (Vector) – Source position socket

Returns

Same as attribute

nearest_transfer(attribute, source_position=None)

Transfer attribute with NEAREST mapping

Parameters

attribute (Any) – The attribute to transfer
source_position (Vector) – Source position socket

Returns

Same as attribute

property offset

“Offset” attribute (offset socket of SetPosition node)

Returns: Vector

getter: Position
setter: SetPosition

property position

Position attribute

Returns: Vector

getter: Position
setter: SetPosition

property radius

Radius attribute

Returns: Float

getter: Radius setter: :class: ~geonodes.nodes.nodes.SetPointRadius

select(selection)

Select the domain

Parameters: selection (Boolean) – The selection condition

If a selection is existing, the resulting selection is a logical and betwenn the two

set_named_attribute(name, value, data_type=None)

Set a named attribute

Called by classes set_named_xxx:

set_named_boolean()
set_named_integer()
set_named_float()
set_named_vector()
set_named_color()
set_named_byte_color()

set_named_boolean(name, value): Set named attribute of type BOOLEAN

set_named_byte_color(name, value): Set named attribute of type BYTE_COLOR

set_named_color(name, value): Set named attribute of type FLOAT_COLOR

set_named_float(name, value): Set named attribute of type FLOAT

set_named_integer(name, value): Set named attribute of type INT

set_named_vector(name, value): Set named attribute of type FLOAT_VECTOR

stack(node)

Make the owning socket jump to the output socket of the node passed in argumment.

Parameters: node (Node) – The node to jump to

statistic(attribute, data_type=None)

Attribute statistic

call AttributeStatistic

to_vertices()

Convert points to vertices.

Node PointsToVertices

Returns: Points

verts = cloud.points.to_vertices()

to_volume(density=None, voxel_size=None, voxel_amount=None, radius=None, resolution_mode='VOXEL_AMOUNT')

Convert points to volume.

Node PointsToVolume

Parameters

density – Float
voxel_size – Float
voxel_amount – Float
radius – Float
resolution_mode (str) – (default = ‘VOXEL_AMOUNT’) in (‘VOXEL_AMOUNT’, ‘VOXEL_SIZE’)

Returns

Volume

volume = cloud.points.to_volume()

transfer_attribute(attribute, source_position=None, index=None, data_type=None, mapping='NEAREST_FACE_INTERPOLATED')

Transfer attribute

Parameters

attribute (Any) – The attribute to transfer
source_position (Vector) – Source position socket
index (Integer) – Index socket
data_type (str) – A valid data type
mapping (str) – str in (‘NEAREST’, ‘INDEX’, ‘NEAREST_FACE_INTERPOLATED’).

Returns

As defined by data_type

If data_type is None, it is computed from the attribute type.

This method is called by a DataSocket with a property field_of pointing on the domain:

# Domain Vertex

verts = mesh.verts

# Attribute position: position.field_of = verts

position = verts.position

# Transfer to a var

location = position.index_transfer()

# Which is equivalent to:

location = verts.index_transfer(verts.position)