net.malisis.core.renderer.component

Class AnimatedModelComponent

java.lang.Object

net.malisis.core.renderer.component.ModelComponent

net.malisis.core.renderer.component.AnimatedModelComponent

All Implemented Interfaces:

IComponent, IRenderComponent

public class AnimatedModelComponent
extends ModelComponent

The AnimatedModelComponent allows animated parts to be rendered for a MalisisBlock without the need for a TileEntitySpecialRenderer nor even a TileEntity.
The model needs to have an animation JSON associated (see IAnimationLoader).
The static parts of the model are rendered as part of the batch when the chunk rerenders. The animated parts are rendered every frame as part of a RenderWorldLastEvent.
Shapes/groups that are referenced by an Animation when loaded are automatically considered animated. The others are considered static.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AnimatedModelComponent.AMC
static interface	AnimatedModelComponent.IRenderCallback The IRenderCallback interface is the callback used for onRender(IRenderCallback)

Nested classes/interfaces inherited from class net.malisis.core.renderer.component.ModelComponent

ModelComponent.IVisibilityProvider

Field Summary

Fields inherited from class net.malisis.core.renderer.component.ModelComponent

model, modelIconProvider, renderParameters, resourceLocation, visibilityProvider

Constructor Summary

Constructors

Constructor and Description
AnimatedModelComponent(java.lang.String modelName) Instantiates a new AnimatedModelComponent.

Method Summary

Modifier and Type	Method and Description
AnimatedModelComponent.AMC	createRenderable(net.minecraft.world.IBlockAccess world, net.minecraft.util.math.BlockPos pos)
Timer	forceStart(net.minecraft.util.math.BlockPos pos, java.lang.String animation) Starts the Timer for the specified animation.
Timer	forceStart(net.minecraft.util.math.BlockPos pos, java.lang.String animation, Timer timer) Start the animation with the specified Timer.
static AnimatedModelComponent	get(java.lang.Object block) Gets the AnimatedModelComponent associated to the IComponentProvider.
java.util.Optional<IAnimatedRenderable>	getRenderable(net.minecraft.util.math.BlockPos pos)
boolean	isAnimating(net.minecraft.util.math.BlockPos pos, java.lang.String animation) Checks the specified animation is already running.
Timer	link(net.minecraft.util.math.BlockPos pos, java.lang.String stop, java.lang.String start) Links two animations together.
void	onRender(AnimatedModelComponent.IRenderCallback renderCallback) Register a callback for when a the block is rendered.
void	render(net.minecraft.block.Block block, MalisisRenderer<? extends net.minecraft.tileentity.TileEntity> renderer) Only called for BLOCK and ITEM render type
Timer	start(net.minecraft.util.math.BlockPos pos, java.lang.String animation) Starts the Timer for the specified animation.
Timer	start(net.minecraft.util.math.BlockPos pos, java.lang.String animation, Timer timer) Start the animation with the specified Timer.
Timer	stop(net.minecraft.util.math.BlockPos pos, java.lang.String animation) Stops the animation.

Methods inherited from class net.malisis.core.renderer.component.ModelComponent

getModel, loadModel, onComponentAdded, setIconProvider

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.malisis.core.renderer.IRenderComponent

isClientComponent

Methods inherited from interface net.malisis.core.block.IComponent

getComponent, getDependencies

Constructor Detail

AnimatedModelComponent

public AnimatedModelComponent(java.lang.String modelName)

Instantiates a new AnimatedModelComponent.

Parameters:

modelName - the model name

Method Detail

getRenderable

public java.util.Optional<IAnimatedRenderable> getRenderable(net.minecraft.util.math.BlockPos pos)

onRender

public void onRender(AnimatedModelComponent.IRenderCallback renderCallback)

Register a callback for when a the block is rendered.
Can be used to trigger animations based on the state.

Parameters:

renderCallback - the state check

start

public Timer start(net.minecraft.util.math.BlockPos pos,
                   java.lang.String animation)

Starts the Timer for the specified animation.
No effect is the animation is already running.

Parameters:

pos - the pos

animation - the animation

Returns:

the timer

start

public Timer start(net.minecraft.util.math.BlockPos pos,
                   java.lang.String animation,
                   Timer timer)

Start the animation with the specified Timer.
No effect if the animation is already running.

Parameters:

pos - the pos

animation - the animation

timer - the timer

Returns:

the timer

forceStart

public Timer forceStart(net.minecraft.util.math.BlockPos pos,
                        java.lang.String animation)

Starts the Timer for the specified animation.
Restarts the animation if it is already running.

Parameters:

pos - the pos

animation - the animation

Returns:

the timer

forceStart

public Timer forceStart(net.minecraft.util.math.BlockPos pos,
                        java.lang.String animation,
                        Timer timer)

Start the animation with the specified Timer.
Restarts the animation if it is already running.

Parameters:

pos - the pos

animation - the animation

timer - the timer

Returns:

the timer

stop

public Timer stop(net.minecraft.util.math.BlockPos pos,
                  java.lang.String animation)

Stops the animation.

Parameters:

pos - the pos

animation - the animation

Returns:

the timer

link

public Timer link(net.minecraft.util.math.BlockPos pos,
                  java.lang.String stop,
                  java.lang.String start)

Links two animations together.
The start animation will replace the stop one. The Timer for start will depend on the time spent by the stop animation.
The purpose is to have seamless transition between two reversed animations. (Ex: opening and closing of a door.)

Parameters:

pos - the pos

stop - the stop

start - the start

Returns:

the timer

isAnimating

public boolean isAnimating(net.minecraft.util.math.BlockPos pos,
                           java.lang.String animation)

Checks the specified animation is already running. (Note that this method will return true if the animation is finished but is set to persist.)

Parameters:

pos - the pos

animation - the animation

Returns:

true, if successful

render

public void render(net.minecraft.block.Block block,
                   MalisisRenderer<? extends net.minecraft.tileentity.TileEntity> renderer)

Only called for BLOCK and ITEM render type

Specified by:

render in interface IRenderComponent

Overrides:

render in class ModelComponent

createRenderable

public AnimatedModelComponent.AMC createRenderable(net.minecraft.world.IBlockAccess world,
                                                   net.minecraft.util.math.BlockPos pos)

get

public static AnimatedModelComponent get(java.lang.Object block)

Gets the AnimatedModelComponent associated to the IComponentProvider.

Parameters:

block - the block

Returns:

the animated model component