Module ncine.drawable_node
The table containing drawable node related functions.
Inherits from ncine.scenenode.
Functions
| ncine.drawable_node.get_width (node) | Returns the width of the node area |
| ncine.drawable_node.get_height (node) | Returns the height of the node area |
| ncine.drawable_node.get_size (node) | Returns the size of the node area |
| ncine.drawable_node.get_anchor_point (node) | Returns the transformation anchor point |
| ncine.drawable_node.set_anchor_point (node, anchor_point) | Sets the transformation anchor point |
| ncine.drawable_node.set_anchor_point (node, x, y) | Sets the transformation anchor point |
| ncine.drawable_node.is_blending_enabled (node) | Returns true if the node renders with blending enabled |
| ncine.drawable_node.set_blending_enabled (node, enabled) | Sets the blending state for node rendering |
| ncine.drawable_node.get_src_blending_factor (node) | eturns the source blending factor |
| ncine.drawable_node.get_dest_blending_factor (node) | Returns the destination blending factor |
| ncine.drawable_node.set_blending_preset (node, preset) | Sets a blending preset for source and destination blending factors |
| ncine.drawable_node.set_blending_factors (node, src_factor, dest_factor) | Sets a specific source and destination blending factors |
| ncine.drawable_node.get_last_frame_rendered (node) | Returns the last frame in which any of the viewports have rendered this node (node was not culled) |
| ncine.drawable_node.get_aabb (node) | Returns the axis-aligned bounding box of the node area in the last frame |
Tables
| drawablenodeObj | The light user data of a drawable node object. |
| ncine.blending_preset | Blending presets (enumeration) |
| ncine.blending_factor | Blending factors (enumeration) |
Functions
- ncine.drawable_node.get_width (node)
-
Returns the width of the node area
Parameters:
- node drawablenodeObj
Returns:
-
number
- ncine.drawable_node.get_height (node)
-
Returns the height of the node area
Parameters:
- node drawablenodeObj
Returns:
-
number
- ncine.drawable_node.get_size (node)
-
Returns the size of the node area
Parameters:
- node drawablenodeObj
Returns:
-
ncine.vec2
- ncine.drawable_node.get_anchor_point (node)
-
Returns the transformation anchor point
Parameters:
- node drawablenodeObj
Returns:
-
ncine.vec2
- ncine.drawable_node.set_anchor_point (node, anchor_point)
-
Sets the transformation anchor point
Parameters:
- node drawablenodeObj
- anchor_point ncine.vec2
- ncine.drawable_node.set_anchor_point (node, x, y)
-
Sets the transformation anchor point
Parameters:
- node drawablenodeObj
- x number
- y number
- ncine.drawable_node.is_blending_enabled (node)
-
Returns
trueif the node renders with blending enabledParameters:
- node drawablenodeObj
Returns:
-
boolean
- ncine.drawable_node.set_blending_enabled (node, enabled)
-
Sets the blending state for node rendering
Parameters:
- node drawablenodeObj
- enabled boolean
- ncine.drawable_node.get_src_blending_factor (node)
-
eturns the source blending factor
Parameters:
- node drawablenodeObj
Returns:
-
ncine.blending_factor
- ncine.drawable_node.get_dest_blending_factor (node)
-
Returns the destination blending factor
Parameters:
- node drawablenodeObj
Returns:
-
ncine.blending_factor
- ncine.drawable_node.set_blending_preset (node, preset)
-
Sets a blending preset for source and destination blending factors
Parameters:
- node drawablenodeObj
- preset ncine.blending_preset
- ncine.drawable_node.set_blending_factors (node, src_factor, dest_factor)
-
Sets a specific source and destination blending factors
Parameters:
- node drawablenodeObj
- src_factor ncine.blending_factor
- dest_factor ncine.blending_factor
- ncine.drawable_node.get_last_frame_rendered (node)
-
Returns the last frame in which any of the viewports have rendered this node (node was not culled)
Parameters:
- node drawablenodeObj
Returns:
-
integer
- ncine.drawable_node.get_aabb (node)
-
Returns the axis-aligned bounding box of the node area in the last frame
Parameters:
- node drawablenodeObj
Returns:
-
ncine.rect
Tables
- drawablenodeObj
-
The light user data of a drawable node object.
Inherits from ncine.scenenode.scenenodeObj.
- ncine.blending_preset
-
Blending presets (enumeration)
Fields:
- DISABLED
- ALPHA
- PREMULTIPLIED_ALPHA
- ADDITIVE
- MULTIPLY
- ncine.blending_factor
-
Blending factors (enumeration)
Fields:
- ZERO
- ONE
- SRC_COLOR
- ONE_MINUS_SRC_COLOR
- DST_COLOR
- ONE_MINUS_DST_COLOR
- SRC_ALPHA
- ONE_MINUS_SRC_ALPHA
- DST_ALPHA
- ONE_MINUS_DST_ALPHA
- CONSTANT_COLOR
- ONE_MINUS_CONSTANT_COLOR
- CONSTANT_ALPHA
- ONE_MINUS_CONSTANT_ALPHA
- SRC_ALPHA_SATURATE