PrimitiveProperties
User-configurable primitive appearance and type-specific geometry properties. Fields that do not apply to the target primitive type are ignored by the setter.
Import
import ScriptingApi as api
# Access the class
# PrimitiveProperties is available via api.PrimitiveProperties
Properties
color
Primitive surface RGB color [r, g, b]. Applies to all primitive types.
Type: list
opacity
Primitive surface opacity in range [0.0, 1.0]. Applies to all primitive types.
Type: float
wireframe
Wireframe display flag. Applies to all primitive types.
Type: bool
resolution
Rendering resolution. Odd values are rounded up to the next even value.
Type: int
point_handle_scale_factor
Point-handle scale factor. Only applies to spline primitives.
Type: float
point_handle_cross_2d_size
2D cross size for point handles in pixels. Applies to all primitive types except spline.
Type: int
point_handle_color
Point-handle RGB color [r, g, b]. Applies to all primitive types.
Type: list
follow_object_profile_enabled
Follow-object-profile flag. Applies to all primitive types.
Type: bool
center
Center position [x, y, z]. Applies to point, circle, sphere, ellipsoid, plane, cube, and cuboid primitives.
Type: list
radius
Radius. Applies to point, circle, sphere, line, cylinder, capsule, tube (outer radius), cone, arrow (shaft radius), and spline (maximum or outer radius) primitives.
Type: float
radius_y
Radius along Y-axis. Only applies to ellipsoid primitives.
Type: float
radius_z
Radius along Z-axis. Only applies to ellipsoid primitives.
Type: float
thickness
Tube wall thickness. Only applies to tube primitives.
Type: float
tip_radius
Arrow tip radius. Only applies to arrow primitives.
Type: float
tip_length_factor
Arrow tip length factor. Only applies to arrow primitives.
Type: float
spline_mode
Spline mode: 0 = Tube, 1 = ThickTube. Only applies to spline primitives.
Type: int
vary_radius
Enables varying radius along the spline. Only applies to spline primitives in tube mode.
Type: bool
min_radius
Minimum spline radius. In thick-tube mode this is the inner radius. Only applies to spline primitives.
Type: float
width
Width. Applies to plane and cuboid primitives, and represents edge length for cube primitives.
Type: float
height
Height. Applies to plane and cuboid primitives.
Type: float
depth
Depth. Only applies to cuboid primitives.
Type: float
point1
Start point [x, y, z]. Applies to line, cylinder, capsule, tube, cone, and arrow primitives.
Type: list
point2
End point [x, y, z]. Applies to line, cylinder, capsule, tube, cone, and arrow primitives.
Type: list
angle
Rotation angle in degrees. Applies to circle, ellipsoid, plane, cube, and cuboid primitives.
Type: float
axis
Rotation axis [x, y, z]. Applies to circle, ellipsoid, plane, cube, and cuboid primitives.
Type: list
points
Spline control points [x, y, z]. Only applies to spline primitives.
Type: list
closed_loop
Closed-loop flag. Only applies to spline primitives.
Type: bool
add_intermediate_node_on_contour
Adds intermediate control points while editing. Only applies to spline primitives.
Type: bool