Spotlight

聚光燈

搖籃

dependencies {
    implementation ' com.github.takusemba:spotlight:x.x.x '
}

用法

 val spotlight = Spotlight . Builder ( this )
    .setTargets(firstTarget, secondTarget, thirdTarget .. .)
    .setBackgroundColor( R .color.spotlightBackground)
    .setDuration( 1000L )
    .setAnimation( DecelerateInterpolator ( 2f ))
    .setContainer(viewGroup)
    .setOnSpotlightListener( object : OnSpotlightListener {
      override fun onStarted () {
        Toast .makeText( this @MainActivity, " spotlight is started " , Toast . LENGTH_SHORT ).show()
      }
      override fun onEnded () {
        Toast .makeText( this @MainActivity, " spotlight is ended " , Toast . LENGTH_SHORT ).show()
      }
    })
    .build()         

如果您想立即顯示 Spotlight，則必須等到視圖佈局完畢。

 // with core-ktx method.
view.doOnPreDraw { Spotlight . Builder ( this ) .. .start() }

目標

建立一個目標以新增 Spotlight。

目標是聚光燈投射的一個點。您可以將多個目標新增至 Spotlight。

 val target = Target . Builder ()
    .setAnchor( 100f , 100f )
    .setShape( Circle ( 100f ))
    .setEffect( RippleEffect ( 100f , 200f , argb( 30 , 124 , 255 , 90 )))
    .setOverlay(layout)
    .setOnTargetListener( object : OnTargetListener {
      override fun onStarted () {
        makeText( this @MainActivity, " first target is started " , LENGTH_SHORT ).show()
      }
      override fun onEnded () {
        makeText( this @MainActivity, " first target is ended " , LENGTH_SHORT ).show()
      }
    })
    .build()

開始/結束聚光燈

 val spotlight = Spotlight . Builder ( this ) .. .start()

spotlight.finish()

下一個/上一個/顯示目標

 val spotlight = Spotlight . Builder ( this ) .. .start()

spotlight.next()

spotlight.previous()

spotlight.show( 2 )

客製化形狀

Shape定義了您的目標的外觀。 Circle 和 RoundedRectangle 形狀已經實現，但如果您想要自訂形狀，可以透過實作Shape介面來實現。

 class CustomShape (
    override val duration : Long ,
    override val interpolator : TimeInterpolator
) : Shape {

  override fun draw ( canvas : Canvas , point : PointF , value : Float , paint : Paint ) {
    // draw your shape here.
  }
}

自訂效果

Effect可讓您裝飾您的目標。 RippleEffect 和 FlickerEffect 形狀已經實現，但如果您想要自訂效果，可以透過實作Effect介面來實現。

 class CustomEffect (
    override val duration : Long ,
    override val interpolator : TimeInterpolator ,
    override val repeatMode : Int
) : Effect {

  override fun draw ( canvas : Canvas , point : PointF , value : Float , paint : Paint ) {
    // draw your effect here.
  }
}

樣本

克隆此存儲庫並查看應用程式模組。

作者

• 船場卓
  • Github - (https://github.com/takusemba)
  • 推特- (https://twitter.com/takusemba)
  • Facebook - (https://www.facebook.com/takusemba)

執照

 Copyright 2017 Taku Semba.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.