Menu tutorialÍndice desta página

Matter.MouseConstraint

O módulo Matter.MouseConstraint contém métodos para criar restrições de mouse. As restrições do mouse são usadas para permitir a interação do usuário, proporcionando a capacidade de mover corpos através do mouse ou do toque.

Veja os exemplos de uso incluídos.

Métodos

Matter.MouseConstraint.create(engine, options) → MouseConstraint

Cria uma nova restrição de mouse. Todas as propriedades possuem valores padrão e muitas são pré-calculadas automaticamente com base em outras propriedades. Consulte a seção de propriedades abaixo para obter informações detalhadas sobre o que você pode passar através do objeto de opções.

Parâmetros

  • engine Engine
  • options Object

Devoluções

MouseConstraint: Uma nova restrição de mouse

Propriedades/Opções

As propriedades a seguir, se especificadas abaixo, são para objetos criados por Matter.MouseConstraint.create e podem ser passadas para ele como opções.

mouseconstraint.body Body

O Corpo que está sendo movido atualmente pelo usuário ou nulo se não houver corpo.

Padrão:null

mouseconstraint.collisionFilter Object

Um Object que especifica as propriedades do filtro de colisão. O filtro de colisão permite ao usuário definir com quais tipos de corpo esta restrição do mouse pode interagir. Consulte body.collisionFilter para obter mais informações.

mouseconstraint.constraint Constraint

O objeto Constraint usado para mover o corpo durante a interação.

mouseconstraint.mouse Mouse

A instância do Mouse em uso. Se não for fornecido em MouseConstraint.create, um será criado.

Padrão:mouse

mouseconstraint.type String

Uma String que denota o tipo de objeto.

Padrão:"constraint"

Eventos

Os eventos a seguir são emitidos por objetos criados por Matter.MouseConstraint.create e recebidos por objetos que foram inscritos usando Matter.Events.on.

Events.on(mouseconstraint, "enddrag", callback)

Disparado quando o usuário termina de arrastar um corpo

Parâmetros de retorno de chamada

  • event ObjectUm objeto de evento
    • mouse MouseA instância do mouse do mecanismo
    • body BodyO corpo que parou de ser arrastado
    • sourceO objeto de origem do evento
    • nameO nome do evento

Events.on(mouseconstraint, "mousedown", callback)

Disparado quando o mouse está pressionado (ou um toque foi iniciado) durante a última etapa

Parâmetros de retorno de chamada

  • event ObjectUm objeto de evento
    • mouse MouseA instância do mouse do mecanismo
    • sourceO objeto de origem do evento
    • nameO nome do evento

Events.on(mouseconstraint, "mousemove", callback)

Disparado quando o mouse se move (ou um toque se move) durante a última etapa

Parâmetros de retorno de chamada

  • event ObjectUm objeto de evento
    • mouse MouseA instância do mouse do mecanismo
    • sourceO objeto de origem do evento
    • nameO nome do evento

Events.on(mouseconstraint, "mouseup", callback)

Disparado quando o mouse está ativado (ou um toque termina) durante a última etapa

Parâmetros de retorno de chamada

  • event ObjectUm objeto de evento
    • mouse MouseA instância do mouse do mecanismo
    • sourceO objeto de origem do evento
    • nameO nome do evento

Events.on(mouseconstraint, "startdrag", callback)

Disparado quando o usuário começa a arrastar um corpo

Parâmetros de retorno de chamada

  • event ObjectUm objeto de evento
    • mouse MouseA instância do mouse do mecanismo
    • body BodyO corpo que parou de ser arrastado
    • sourceO objeto de origem do evento
    • nameO nome do evento
Lista de comentários
Carregando..