Class RenderComponent

The RenderComponent enables an Entity to render 3D meshes. The RenderComponent#type property can be set to one of several predefined shape types (such as box, sphere, cone and so on). Alternatively, the component can be configured to manage an arbitrary array of MeshInstance objects. These can either be created programmatically or loaded from an Asset.

You should never need to use the RenderComponent constructor directly. To add a RenderComponent to an Entity, use Entity#addComponent:

// Add a render component to an entity with the default options
const entity = new pc.Entity();
entity.addComponent("render");  // This defaults to a 1x1x1 box

To create an entity with a specific primitive shape:

entity.addComponent("render", {
    type: "cone",
    castShadows: false,
    receiveShadows: false
});

Once the RenderComponent is added to the entity, you can set and get any of its properties:

entity.render.type = 'capsule';  // Set the render component's type

console.log(entity.render.type); // Get the render component's type and print it

Relevant examples:

Hierarchy (View Summary)

Constructors

constructor

Properties

entity isStatic system

Accessors

asset batchGroupId castShadows castShadowsLightmap customAabb enabled layers lightmapped lightmapSizeMultiplier material materialAssets meshInstances receiveShadows renderStyle type

Methods

fire hasEvent hide off on once show

Constructors

constructor

Properties

entity

entity: Entity

The Entity that this Component is attached to.

isStatic

isStatic: boolean = false

Mark meshes as non-movable (optimization).

system

system: ComponentSystem

The ComponentSystem used to create this Component.

Accessors

asset

batchGroupId

castShadows

castShadowsLightmap

customAabb

enabled

layers

lightmapped

lightmapSizeMultiplier

material

materialAssets

meshInstances

receiveShadows

renderStyle

type

  • get type(): string

  • Gets the type of the component.

    Returns string

  • set type(value: string): void

  • Sets the type of the component. Can be one of the following:

    • "asset": The component will render a render asset
    • "box": The component will render a box (1 unit in each dimension)
    • "capsule": The component will render a capsule (radius 0.5, height 2)
    • "cone": The component will render a cone (radius 0.5, height 1)
    • "cylinder": The component will render a cylinder (radius 0.5, height 1)
    • "plane": The component will render a plane (1 unit in each dimension)
    • "sphere": The component will render a sphere (radius 0.5)
    • "torus": The component will render a torus (tubeRadius: 0.2, ringRadius: 0.3)

    Parameters

    • value: string

    Returns void

Methods

fire

  • fire(
        name: string,
        arg1?: any,
        arg2?: any,
        arg3?: any,
        arg4?: any,
        arg5?: any,
        arg6?: any,
        arg7?: any,
        arg8?: any,
    ): EventHandler

  • Fire an event, all additional arguments are passed on to the event listener.

    Parameters

    • name: string

      Name of event to fire.

    • Optionalarg1: any

      First argument that is passed to the event handler.

    • Optionalarg2: any

      Second argument that is passed to the event handler.

    • Optionalarg3: any

      Third argument that is passed to the event handler.

    • Optionalarg4: any

      Fourth argument that is passed to the event handler.

    • Optionalarg5: any

      Fifth argument that is passed to the event handler.

    • Optionalarg6: any

      Sixth argument that is passed to the event handler.

    • Optionalarg7: any

      Seventh argument that is passed to the event handler.

    • Optionalarg8: any

      Eighth argument that is passed to the event handler.

    Returns EventHandler

    Self for chaining.

    Example

    obj.fire('test', 'This is the message');

hasEvent

  • hasEvent(name: string): boolean

  • Test if there are any handlers bound to an event name.

    Parameters

    • name: string

      The name of the event to test.

    Returns boolean

    True if the object has handlers bound to the specified event name.

    Example

    obj.on('test', function () { }); // bind an event to 'test'
    obj.hasEvent('test'); // returns true
    obj.hasEvent('hello'); // returns false

hide

off

  • off(name?: string, callback?: HandleEventCallback, scope?: object): EventHandler

  • Detach an event handler from an event. If callback is not provided then all callbacks are unbound from the event, if scope is not provided then all events with the callback will be unbound.

    Parameters

    • Optionalname: string

      Name of the event to unbind.

    • Optionalcallback: HandleEventCallback

      Function to be unbound.

    • Optionalscope: object

      Scope that was used as the this when the event is fired.

    Returns EventHandler

    Self for chaining.

    Example

    const handler = function () {
    };
    obj.on('test', handler);

    obj.off(); // Removes all events
    obj.off('test'); // Removes all events called 'test'
    obj.off('test', handler); // Removes all handler functions, called 'test'
    obj.off('test', handler, this); // Removes all handler functions, called 'test' with scope this

on

  • on(name: string, callback: HandleEventCallback, scope?: object): EventHandle

  • Attach an event handler to an event.

    Parameters

    • name: string

      Name of the event to bind the callback to.

    • callback: HandleEventCallback

      Function that is called when event is fired. Note the callback is limited to 8 arguments.

    • Optionalscope: object = ...

      Object to use as 'this' when the event is fired, defaults to current this.

    Returns EventHandle

    Can be used for removing event in the future.

    Example

    obj.on('test', function (a, b) {
        console.log(a + b);
    });
    obj.fire('test', 1, 2); // prints 3 to the console

    Example

    const evt = obj.on('test', function (a, b) {
        console.log(a + b);
    });
    // some time later
    evt.off();

once

  • once(name: string, callback: HandleEventCallback, scope?: object): EventHandle

  • Attach an event handler to an event. This handler will be removed after being fired once.

    Parameters

    • name: string

      Name of the event to bind the callback to.

    • callback: HandleEventCallback

      Function that is called when event is fired. Note the callback is limited to 8 arguments.

    • Optionalscope: object = ...

      Object to use as 'this' when the event is fired, defaults to current this.

    Returns EventHandle

    • can be used for removing event in the future.

    Example

    obj.once('test', function (a, b) {
        console.log(a + b);
    });
    obj.fire('test', 1, 2); // prints 3 to the console
    obj.fire('test', 1, 2); // not going to get handled

show

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods