ViroPolygon represents a one-sided plane whose boundary is defined by a list of vertices. ViroPolygon can be used to form any convex or concave 2D shape, and can be assigned any material.
Example use
<ViroPolygon rotation={[-90, 0, 0]}
position={[0,0,0]}
vertices={[[-1,0], [0,1], [1,0]]}
materials={"blue_plane"}/>
Props
Required Props
PropKey | PropType |
---|---|
vertices | PropTypes.arrayOf(PropTypes.arrayOf(PropTypes.number)).isRequired An array of boundary vertex positions in local model space. Each point is a 2D array consisting of an X and a Y coordinate. For example: |
holes | PropTypes.arrayOf(PropTypes.arrayOf(PropTypes.arrayOf(PropTypes.number))) An array of arrays. Each inner array contains the boundary vertex positions that define a hole in the polygon. Each vertex position is a 2D array consisting of an X and a Y coordinate in local model space. For example: |
Optional Props
PropKey | PropType | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
animation | PropTypes.shape({ A collection of parameters that determine if and how this component should animate. For more information on animated components please see our Animation Guide. | ||||||||||
arShadowReceiver | PropTypes.bool When set to true, this control will act as a transparent surface and capture any shadows that are cast onto it. | ||||||||||
dragPlane | PropTypes.shape({ When a drag type of "FixedToPlane" is given, dragging is limited to a user defined plane. The dragging behavior is then configured by this property (specified by a point on the plane and its normal vector). You can also limit the maximum distance the dragged object is allowed to travel away from the camera/controller (useful for situations where the user can drag an object towards infinity). | ||||||||||
dragType | PropTypes.oneOf(["FixedDistance", "FixedToWorld"]) Determines the behavior of drag if onDrag is specified.
The default value is "FixedDistance". | ||||||||||
highAccuracyEvents | PropTypes.bool True if events should use the geometry of the object to determine if the user is interacting with this object. If false, the object's axis-aligned bounding box will be used instead. Enabling this is more accurate but takes more processing power, so it is set to false by default. | ||||||||||
ignoreEventHandling | PropTypes.bool When set to true, this control will ignore events and not prevent controls behind it from receiving event callbacks. The default value is false. | ||||||||||
lightReceivingBitMask | PropTypes.number A bit mask that is bitwise and-ed (&) with each light's influenceBitMask. If the result is > 0, then the light will illuminate this object. For more information please see the Lighting and Materials Guide. | ||||||||||
materials | PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.string),PropTypes.string]) An array of strings that each represent a material that was created via ViroMaterials.createMaterials(). | ||||||||||
onCollision | React.PropTypes.func Called when this component's physics body collides with another component's physics body. Also invoked by ViroScene/ViroARScene's
| ||||||||||
onClick | React.PropTypes.func Called when an object has been clicked. Example code:
The position parameter represents the position in world coordinates on the object where the click occurred. For the mapping of sources to controller inputs, see the Events section. | ||||||||||
onClickState | React.PropTypes.func Called for each click state an object goes through as it is clicked. Supported click states and their values are the following:
Example code:
For the mapping of sources to controller inputs, see the Events section. | ||||||||||
onDrag | React.PropTypes.func Called when the view is currently being dragged. The dragToPos parameter provides the current 3D location of the dragged object. Example code:
For the mapping of sources to controller inputs, see the Events section. Unsupported VR Platforms: Cardboard iOS | ||||||||||
onFuse | PropTypes.oneOfType
As shown above, onFuse takes one of the types - either a callback, or a dictionary with a callback and duration. It is called after the user hovers onto and remains hovered on the control for a certain duration of time, as indicated in timeToFuse that represents the duration of time in milliseconds. While hovering, the reticle will display a count down animation while fusing towards timeToFuse. Note that timeToFuse defaults to 2000ms. For example:
For the mapping of sources to controller inputs, see the Events section. | ||||||||||
onHover | React.PropTypes.func Called when the user hovers on or off the control. For example:
The position parameter represents the position in world coordinates on the object where the click occurred. For the mapping of sources to controller inputs, see the Events section. | ||||||||||
onPinch | React.PropTypes.func Called when the user performs a pinch gesture on the control. When the pinch starts, the scale factor is set to 1 is relative to the points of the two touch points. For example:
pinchState can be the following values:
This event is only available in AR. | ||||||||||
onRotate | React.PropTypes.func Called when the user performs a rotation touch gesture on the control. Rotation factor is returned in degrees. When setting rotation, the rotation should be relative to it's current rotation, not set to the absolute value of the given rotationFactor. For example:
rotationState can be the following values:
This event is only available in AR. | ||||||||||
onScroll | React.PropTypes.func Called when the user performs a scroll action, while hovering on the control. For example:
For the mapping of sources to controller inputs, see the Events section. Unsupported VR Platforms: Cardboard(Android and iOS) | ||||||||||
onSwipe | React.PropTypes.func Called when the user performs a swipe gesture on the physical controller, while hovering on this control. For example:
For the mapping of sources to controller inputs, see the Events section. Unsupported VR Platforms: Cardboard(Android and iOS) | ||||||||||
onTouch | React.PropTypes.func Called when the user performs a touch action, while hovering on the control. Provides the touch state type, and the x/y coordinate at which this touch event has occurred.
For example:
The touchPos parameter represents the position in world coordinates on the object where the click occurred. For the mapping of sources to controller inputs, see the Events section. Unsupported VR Platforms: Cardboard(Android and iOS). | ||||||||||
onTransformUpdate | PropTypes.func A function that is invoked when the component moves and provides an array of numbers representing the component's position in world coordinates. | ||||||||||
opacity | PropTypes.number A number from 0 to 1 that specifies the opacity of the object. A value of 1 translates into a fully opaque object while 0 represents full transparency. | ||||||||||
physicsBody | PropTypes.shape({..physics.api..}), Creates and binds a physics body that is configured with the provided collection of physics properties associated with this control. For more information on physics components, please see the physics.api. | ||||||||||
position | PropTypes.arrayOf(PropTypes.number) Cartesian position of the text in 3D world space, specified as [x, y, z]. | ||||||||||
rotation | PropTypes.arrayOf(PropTypes.number) The rotation of the text around it's local axis specified as Euler angles [x, y, z]. Units for each angle are specified in degrees. | ||||||||||
rotationPivot | PropTypes.arrayOf(PropTypes.number) Cartesian position in [x,y,z] about which rotation is applied relative to the component's position. | ||||||||||
scale | PropTypes.arrayOf(PropTypes.number) The scale of the surface in 3D space, specified as [x,y,z]. A scale of 1 represents the current size of the surface. A scale value of < 1 will make the surface proportionally smaller while a value >1 will make the surface proportionally bigger along the specified axis. | ||||||||||
scalePivot | PropTypes.arrayOf(PropTypes.number) Cartesian position in [x,y,z] from which scale is applied relative to the component's position. | ||||||||||
shadowCastingBitMask | PropTypes.number A bit mask that is bitwise and-ed (&) with each light's influenceBitMask. If the result is > 0, then this object will cast shadows from the light. For more information please see the Lighting and Materials Guide. | ||||||||||
style | stylePropType Style properties determine the position and scale of the component within a ViroFlexView. Please see the UI Controls & Flexbox guide and Styles reference for more information. | ||||||||||
transformBehaviors | PropTypes.arrayOf(PropTypes.string) An array of transform constraints that affect the transform of the object. For example, putting the value "billboard" will ensure the box is facing the user as the user rotates their head on any axis. This is useful for icons or text where you'd like the box to always face the user at a particular rotation. Allowed values(values are case sensitive):
| ||||||||||
uvCoordinates | PropTypes.arrayOf(PropTypes.number) An array of 4 values [u0, v0, u1, v1] representing the UV-coordinates which determines how a texture should be tiled across the surface. Texture coordinates are represented on 2D U and V axes (essentially the X and Y axes of the image). The left edge of a texture is U = 0.0 and the right edge of the texture is U = 1.0. Similarly, the top edge of a texture is V=0.0 and the bottom edge of the texture is V=1.0. Specifying greater than 1.0 on either the U or V axis will cause the tile to repeat itself or clamp, depending on the Material's | ||||||||||
viroTag | PropTypes.string A tag given to other components when their physics body collides with this component's physics body. Refer to physics for more information. | ||||||||||
visible | PropTypes.bool False if the text should be hidden. By default the text is visible and this value is true. | ||||||||||
renderingOrder | PropTypes.number This determines the order in which this Node is rendered relative to other Nodes. Nodes with greater rendering orders are rendered last. The default rendering order is zero. For example, setting a Node's rendering order to -1 will cause the Node to be rendered before all Nodes with rendering orders greater than or equal to 0. |
Methods
async getTransformAsync() | ||||
---|---|---|---|---|
Async function that returns the component's transform (position, scale and rotation).
|
applyImpulse(force: arrayOf(number), position: arrayOf(number)) | ||||
---|---|---|---|---|
A function used with physics to apply an impulse (instantaneous) force to an object with a physics body.
|
applyTorqueImpulse(torque: arrayOf(number), position: arrayOf(number)) | ||||||
---|---|---|---|---|---|---|
A function used with physics to apply an impulse (instantaneous) torque to an object with a physics body.
|
setVelocity(velocity: arrayOf(number)) | ||||
---|---|---|---|---|
A function used with physics to set the velocity of an object with a physics body.
|
setNativeProps(nativeProps: object) | ||||
---|---|---|---|---|
A wrapper function around the native component's setNativeProps which allow users to set values on the native component without changing state/setting props and re-rendering. Refer to the React Native documentation on Direct Manipulation for more information.
For example, setting position natively would look like this:
|
Updated less than a minute ago