pub struct NodeContext {Show 25 fields
pub expanded_node: Weak<ExpandedNode>,
pub slot_index: Property<Option<usize>>,
pub local_stack_frame: Rc<RuntimePropertiesStackFrame>,
pub containing_component: Weak<ExpandedNode>,
pub elapsed_frames: Property<u64>,
pub elapsed_millis: Property<u64>,
pub gyro: Property<Gyro>,
pub accel: Property<Accel>,
pub bounds_parent: Property<(f64, f64)>,
pub bounds_self: Property<(f64, f64)>,
pub measured_size: Property<Option<(f64, f64)>>,
pub subtree_layout_hull: Property<LayoutHull>,
pub platform: Platform,
pub os: OS,
pub target: Property<TargetInfo>,
pub viewport: Property<Viewport>,
pub projected_children_count: Property<usize>,
pub node_transform_and_bounds: TransformAndBounds<NodeLocal, Window>,
pub projected_children: Property<Vec<Rc<ExpandedNode>>>,
pub projected_children_changed: Property<()>,
pub received_children: Property<Vec<Rc<ExpandedNode>>>,
pub received_children_count: Property<usize>,
pub received_children_changed: Property<()>,
pub retained_received_children: Property<Vec<Rc<ExpandedNode>>>,
pub retained_received_children_changed: Property<()>,
/* private fields */
}Expand description
Runtime context passed into user component lifecycle methods and event handlers.
Child-related fields intentionally separate semantic payload from engine transport:
projected_childrenis the raw transport family used bySlotreceived_childrenis the normalized semantic payload that this node should treat as content from its callerretained_received_childrenare former received children kept alive only so@outtransitions can finish
A node’s own private template or primitive-assembled structure is intentionally not surfaced here as a first-class “child family” for container consumers.
Fields§
§expanded_node: Weak<ExpandedNode>§slot_index: Property<Option<usize>>slot index of this node in its container
local_stack_frame: Rc<RuntimePropertiesStackFrame>Stack frame of this component, used to look up stores
containing_component: Weak<ExpandedNode>Reference to the ExpandedNode of the component containing this node
elapsed_frames: Property<u64>The current global engine frame count.
elapsed_millis: Property<u64>The current global engine wall-clock time in milliseconds.
gyro: Property<Gyro>Current device orientation sensor reading.
accel: Property<Accel>Current device accelerometer reading.
bounds_parent: Property<(f64, f64)>The bounds of this element’s immediate container (parent) in px
bounds_self: Property<(f64, f64)>The bounds of this element in px
measured_size: Property<Option<(f64, f64)>>Measured bounds resolved by the chassis or container layout for this node.
subtree_layout_hull: Property<LayoutHull>Node-local subtree layout hull published by the engine for container measurement.
platform: PlatformCurrent platform (Web/Native) this app is running on
os: OSCurrent os (Android/Windows/Mac/Linux) this app is running on
target: Property<TargetInfo>Derived target facts for platform/OS checks.
viewport: Property<Viewport>Derived viewport facts for size and orientation checks.
projected_children_count: Property<usize>The number of projected children available to this node.
This is the raw transport count used by slot-driven implementations.
Container-style consumers usually want received_children_count
instead.
node_transform_and_bounds: TransformAndBounds<NodeLocal, Window>The transform of this node in the global coordinate space
projected_children: Property<Vec<Rc<ExpandedNode>>>Children projected into this node from the containing component.
Projection is an engine transport mechanism. Consumers that want the
semantic payload owned by this node should prefer received_children.
projected_children_changed: Property<()>A structural invalidation signal for projected children.
received_children: Property<Vec<Rc<ExpandedNode>>>Semantic payload children received by this node from its caller.
This is the canonical “content” view for container-style logic. It
excludes private encapsulated implementation children and also excludes
exit-retained payload nodes, which instead appear in
retained_received_children.
received_children_count: Property<usize>Convenience count derived from received_children.
received_children_changed: Property<()>A structural invalidation signal for received_children.
Prefer this or received_children itself for structural subscriptions
that must react to reorders as well as insertions and removals.
retained_received_children: Property<Vec<Rc<ExpandedNode>>>Received children retained only so exit transitions can finish.
These are no longer part of the active semantic payload, but some
containers still need to place them as ghosts or overlays while their
@out transitions run.
retained_received_children_changed: Property<()>A structural invalidation signal for retained_received_children.
Implementations§
Source§impl NodeContext
impl NodeContext
Sourcepub fn push_local_store<T: Store>(&self, store: T)
pub fn push_local_store<T: Store>(&self, store: T)
Push component-local state onto the runtime stack for descendants to find.
Sourcepub fn peek_local_store<T: Store, V>(
&self,
f: impl FnOnce(&mut T) -> V,
) -> Result<V, String>
pub fn peek_local_store<T: Store, V>( &self, f: impl FnOnce(&mut T) -> V, ) -> Result<V, String>
Borrow the nearest stack-local store of type T.
Sourcepub fn local_point(&self, p: Point2<Window>) -> Point2<NodeLocal>
pub fn local_point(&self, p: Point2<Window>) -> Point2<NodeLocal>
Convert a window-space point into this node’s local coordinate space, including any presentation offsets inherited from ancestor scrollers.
Sourcepub fn get_node_interface(&self) -> Option<NodeInterface>
pub fn get_node_interface(&self) -> Option<NodeInterface>
Return the interface for this node’s containing component, when present.
Sourcepub fn elapsed_time_millis(&self) -> u128
pub fn elapsed_time_millis(&self) -> u128
Milliseconds elapsed according to the chassis-provided clock.
Sourcepub fn subscribe(
&self,
dependencies: &[UntypedProperty],
f: impl Fn() + 'static,
)
pub fn subscribe( &self, dependencies: &[UntypedProperty], f: impl Fn() + 'static, )
Attach a dependency subscription whose callback runs when any dependency dirties.
Sourcepub fn clear_subscriptions(&self)
pub fn clear_subscriptions(&self)
Remove all subscriptions registered on this node.
Ask the chassis to navigate to a URL.
On web targets, same-origin navigation in the current tab can be handled through the browser History API and routed back into Pax without a full page reload. Other targets use the active chassis navigation behavior.
Sourcepub fn dispatch_event(&self, identifier: &'static str) -> Result<(), String>
pub fn dispatch_event(&self, identifier: &'static str) -> Result<(), String>
Queue a named custom event from this component for dispatch at the end of the tick.
Sourcepub fn set_cursor(&self, cursor: CursorStyle)
pub fn set_cursor(&self, cursor: CursorStyle)
Ask the chassis to display the requested cursor over the app surface.
Sourcepub fn screenshot(&self, id: u32)
pub fn screenshot(&self, id: u32)
Request a screenshot capture from the chassis, keyed by caller-provided id.
Sourcepub fn get_screenshot_map(&self) -> Rc<RefCell<HashMap<u32, ScreenshotData>>>
pub fn get_screenshot_map(&self) -> Rc<RefCell<HashMap<u32, ScreenshotData>>>
Shared map where completed screenshot captures are published by id.